ivandika3 commented on code in PR #4585:
URL: https://github.com/apache/ozone/pull/4585#discussion_r1322388864
##########
hadoop-hdds/docs/content/interface/ReconApi.md:
##########
@@ -774,6 +774,114 @@ Returns a summary of the current state of the Ozone
cluster.
}
```
+## Volumes (admin only)
+
+### GET /api/v1/om/volumes
+
+**Parameters**
+
+* prevKey (optional)
+
+ Only returns the volume after the given prevKey.
+ Example: prevKey=vol1
+
+* limit (optional)
+
+ Only returns the limited number of results. The default limit is 1000.
+
+**Returns**
+
+Returns all the volumes in the cluster.
+
+```json
+ {
+ "totalCount": 4,
+ "volumes": [{
+ "volume": "vol1",
+ "owner": "testuser",
+ "admin": "ozone",
+ "creationTime": "2019-11-26T21:18:43.688Z",
+ "modificationTime": "2019-11-26T21:18:46.062Z",
+ "quotaInNamespace": 2048,
+ "quotaInBytes": 1073741824,
+ "usedNamespace": 10,
+ "acls": [
+ {
+ "type": "USER",
+ "name": "testuser",
+ "scope": "ACCESS",
+ "aclList": [
+ "WRITE",
+ "READ",
+ "DELETE"
+ ]
+ }
+ ]
+ },
+ ...
+ ]
+ }
+```
+
+## Buckets (admin only)
+
+### GET /api/v1/om/buckets
+
+**Parameters**
+
+* volume (optional)
+
+ The volume in string without any protocol prefix.
+
+* prevKey (optional)
+
+ Only returns the bucket after the given prevKey. prevKey is ignored if
volume is not specified.
+ Example: prevKey=bucket1
+
+* limit (optional)
+
+ Only returns the limited number of results. The default limit is 1000.
+
+
+**Returns**
+
+Returns all the volumes in the cluster if volume is not specified or it is an
empty string.
Review Comment:
Yes, thank you for catching it. Updated/
##########
hadoop-hdds/docs/content/interface/ReconApi.md:
##########
@@ -774,6 +774,114 @@ Returns a summary of the current state of the Ozone
cluster.
}
```
+## Volumes (admin only)
+
+### GET /api/v1/om/volumes
+
+**Parameters**
+
+* prevKey (optional)
+
+ Only returns the volume after the given prevKey.
+ Example: prevKey=vol1
+
+* limit (optional)
+
+ Only returns the limited number of results. The default limit is 1000.
+
+**Returns**
+
+Returns all the volumes in the cluster.
+
+```json
+ {
+ "totalCount": 4,
+ "volumes": [{
+ "volume": "vol1",
+ "owner": "testuser",
+ "admin": "ozone",
+ "creationTime": "2019-11-26T21:18:43.688Z",
+ "modificationTime": "2019-11-26T21:18:46.062Z",
+ "quotaInNamespace": 2048,
+ "quotaInBytes": 1073741824,
+ "usedNamespace": 10,
+ "acls": [
+ {
+ "type": "USER",
+ "name": "testuser",
+ "scope": "ACCESS",
+ "aclList": [
+ "WRITE",
+ "READ",
+ "DELETE"
+ ]
+ }
+ ]
+ },
+ ...
+ ]
+ }
+```
+
+## Buckets (admin only)
+
+### GET /api/v1/om/buckets
+
+**Parameters**
+
+* volume (optional)
+
+ The volume in string without any protocol prefix.
+
+* prevKey (optional)
+
+ Only returns the bucket after the given prevKey. prevKey is ignored if
volume is not specified.
+ Example: prevKey=bucket1
+
+* limit (optional)
+
+ Only returns the limited number of results. The default limit is 1000.
+
+
+**Returns**
+
+Returns all the volumes in the cluster if volume is not specified or it is an
empty string.
Review Comment:
Yes, thank you for catching it. Updated.
--
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]
