Queries grouping information about servers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

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 natural language of the request and response. Valid values:

  • zh: Chinese
  • en: English

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
Count Integer 2

The total number of server groups.

Groups Array of Group

The grouping information about the servers.

GroupFlag Integer 1

The type of the server group. Valid values:

  • 0: default group
  • 1: other groups
GroupId Integer 8834224

The ID of the server group.

GroupName String abc

The name of the server group.

RequestId String 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

<DescribeAllGroupsResponse>
      <RequestId>2E713E1D-1A0F-4B35-B377-99D144A1EFFE</RequestId>
      <Groups>
            <GroupName>Default</GroupName>
            <GroupFlag>0</GroupFlag>
            <GroupId>9207613</GroupId>
      </Groups>
      <Groups>
            <GroupName>abc</GroupName>
            <GroupFlag>1</GroupFlag>
            <GroupId>9325310</GroupId>
      </Groups>
      <Groups>
            <GroupName>efg</GroupName>
            <GroupFlag>1</GroupFlag>
            <GroupId>9454789</GroupId>
      </Groups>
      <Groups>
            <GroupName>hij</GroupName>
            <GroupFlag>1</GroupFlag>
            <GroupId>9535356</GroupId>
      </Groups>
      <Count>4</Count>
</DescribeAllGroupsResponse>

JSON format

{
	"RequestId": "2E713E1D-1A0F-4B35-B377-99D144A1EFFE",
	"Groups": [
		{
			"GroupName": "Default",
			"GroupFlag": 0,
			"GroupId": 9207613
		},
		{
			"GroupName": "abc",
			"GroupFlag": 1,
			"GroupId": 9325310
		},
		{
			"GroupName": "efg",
			"GroupFlag": 1,
			"GroupId": 9454789
		},
		{
			"GroupName": "hij",
			"GroupFlag": 1,
			"GroupId": 9535356
		}
	],
	"Count": 4
}

Error codes

For a list of error codes, visit the API Error Center.