You can call this operation to query the grouping information about servers.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeAllGroups |
The operation that you want to perform. Set the value to DescribeAllGroups. |
Lang | String | No | zh |
The language of the request and response. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Count | Integer | 2 |
The number of entries returned on the current page. |
Groups | Array |
The grouping information about the servers. |
|
GroupFlag | Integer | 1 |
The type of the server group.
|
GroupId | Integer | 8834224 |
The ID of the server group. |
GroupName | String | test |
The name of the server group. |
RequestId | String | "requestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F", |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeAllGroups
&<Common request parameters>
Sample success responses
XML
format
<DescribeAllGroups>
<Groups>
<GroupFlag>0</GroupFlag>
<GroupName>Ungrouped</GroupName>
<GroupId>4120080</GroupId>
</Groups>
<Groups>
<GroupFlag>1</GroupFlag>
<GroupName>leaves</GroupName>
<GroupId>8831497</GroupId>
</Groups>
<Groups>
<GroupFlag>1</GroupFlag>
<GroupName>test</GroupName>
<GroupId>8834224</GroupId>
</Groups>
<Count>3</Count>
<RequestId>9DD4B19B-CA32-41DA-AED7-77B4F84A91D5</RequestId>
</DescribeAllGroups>
JSON
format
{
"Groups":[
{
"GroupFlag":0,
"GroupName":"Ungrouped",
"GroupId":4120080
},
{
"GroupFlag":1,
"GroupName":"leaves",
"GroupId":8831497
},
{
"GroupFlag":1,
"GroupName":"test",
"GroupId":8834224
}
],
"Count":3,
"RequestId":"9DD4B19B-CA32-41DA-AED7-77B4F84A91D5"
}
Error codes
For a list of error codes, visit the API Error Center.