kerneltime commented on a change in pull request #2566:
URL: https://github.com/apache/ozone/pull/2566#discussion_r695233729
##########
File path: hadoop-hdds/docs/content/interface/ReconApi.md
##########
@@ -232,7 +232,174 @@ Returns the UnhealthyContainerMetadata objects for all
the unhealthycontainers.
Returns the UnhealthyContainerMetadata objects for the containers in the
givenstate.
Possible unhealthy container states are `MISSING`,
`MIS_REPLICATED`,`UNDER_REPLICATED`, `OVER_REPLICATED`.
The response structure is same as `/containers/unhealthy`.
-
+
+## Namespace Metadata
+
+### GET /api/v1/namespace/summary
+
+**Parameters**
+
+* path
+
+ The path request in string without any protocol prefix.
+
+**Returns**
+
+Returns a basic summary of the path, including entity type and aggregate count
+of objects under the path.
+
+`status` is `OK` if path exists, `PATH_NOT_FOUND` otherwise.
+
+Example: /api/v1/namespace/summary?path=/
+```json
+ {
+ "status": OK,
+ "type": ROOT,
+ "numVolume": 10,
+ "numBucket": 100,
+ "numDir": 1000,
+ "numKey": 10000
+ }
+```
+
+If any `num` field is `-1`, the path request is not applicable to such an
entity type.
+
+### GET /api/v1/namespace/du
+
+**Parameters**
+
+* path
+
+ The path request in string without any protocol prefix.
+
+* files (optional)
+
+ A boolean with a default value of `false`. If set to `true`, compute disk
usage for keys
+ directly under the path.
Review comment:
A boolean with a default value of `false`. If set to `true`, _computes_
disk usage for keys
under the path.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
