Lists groups.
Try it now
Test
RAM authorization
Request syntax
POST /v2/group/list HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| domain_id |
string |
Yes |
||
| body |
object |
No |
The request body. |
|
| limit |
integer |
No |
The maximum number of resources to return. The default value is 100, and the maximum value is 100. |
100 |
| marker |
string |
No |
The pagination token that specifies the starting point for the query. Results are returned in alphabetical order, starting from the item that follows the marker. If you do not specify this parameter, the query starts from the beginning of the collection. |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response body. |
||
| items |
array |
A list of group objects. |
|
| Group |
A group object. |
||
| next_marker |
string |
The token that you can use to retrieve the next page of results. This parameter is not returned if all results have been retrieved. |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
Examples
Success response
JSON format
{
"items": [
{
"domain_id": "bj1",
"group_id": "b45c0c0c373c41ec9ebb5c85a025a08f",
"group_name": "test group",
"description": "created by system",
"created_at": 0,
"updated_at": 0,
"creator": "c9b7a5aa04d14ae3867fdc886fa01da4",
"is_sync": true
}
],
"next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.