This is an automated email from the ASF dual-hosted git repository.
siyao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozone.git
The following commit(s) were added to refs/heads/master by this push:
new af6c018 HDDS-5637. Addendum: Add documentation for Recon Namespace
REST APIs (#2579)
af6c018 is described below
commit af6c0180b22fe3688314eb04a9447e48c8f384d3
Author: Yuan Gu <[email protected]>
AuthorDate: Wed Aug 25 18:46:51 2021 -0400
HDDS-5637. Addendum: Add documentation for Recon Namespace REST APIs (#2579)
---
hadoop-hdds/docs/content/interface/ReconApi.md | 54 ++++++++++++++++++++++++--
1 file changed, 51 insertions(+), 3 deletions(-)
diff --git a/hadoop-hdds/docs/content/interface/ReconApi.md
b/hadoop-hdds/docs/content/interface/ReconApi.md
index 260e9ce..99eb70d 100644
--- a/hadoop-hdds/docs/content/interface/ReconApi.md
+++ b/hadoop-hdds/docs/content/interface/ReconApi.md
@@ -262,6 +262,54 @@ Example: /api/v1/namespace/summary?path=/
}
```
+Example: /api/v1/namespace/summary?path=/volume1
+```json
+ {
+ "status": OK,
+ "type": VOLUME,
+ "numVolume": -1,
+ "numBucket": 10,
+ "numDir": 100,
+ "numKey": 1000
+ }
+```
+
+Example: /api/v1/namespace/summary?path=/volume1/bucket1
+```json
+ {
+ "status": OK,
+ "type": BUCKET,
+ "numVolume": -1,
+ "numBucket": -1,
+ "numDir": 50,
+ "numKey": 500
+ }
+```
+
+Example: /api/v1/namespace/summary?path=/volume1/bucket1/dir
+```json
+ {
+ "status": OK,
+ "type": DIRECTORY,
+ "numVolume": -1,
+ "numBucket": -1,
+ "numDir": 10,
+ "numKey": 100
+ }
+```
+
+Example: /api/v1/namespace/summary?path=/volume1/bucket1/dir/nestedDir
+```json
+ {
+ "status": OK,
+ "type": DIRECTORY,
+ "numVolume": -1,
+ "numBucket": -1,
+ "numDir": 5,
+ "numKey": 50
+ }
+```
+
If any `num` field is `-1`, the path request is not applicable to such an
entity type.
### GET /api/v1/namespace/du
@@ -274,12 +322,12 @@ If any `num` field is `-1`, the path request is not
applicable to such an entity
* files (optional)
- A boolean with a default value of `false`. If set to `true`, compute disk
usage for keys
- directly under the path.
+ A boolean with a default value of `false`. If set to `true`, computes disk
usage for keys
+ under the path.
* replica (optional)
- A boolean with a default value of `false`. If set to `true`, compute disk
usage with replicated
+ A boolean with a default value of `false`. If set to `true`, computes disk
usage with replicated
size of keys.
**Returns**
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
