All Products
Search
Document Center

Security Center:DescribeAllGroups

Last Updated:Sep 24, 2024

Queries the information about server groups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeAllGroupsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The natural language of the request and response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object
Countinteger

The total number of server groups.

2
RequestIdstring

The ID of the request.

7E0618A9-D5EF-4220-9471-C42B5E92719F
Groupsarray<object>

The grouping information about the servers.

Groupobject
GroupNamestring

The name of the server group.

abc
GroupIdinteger

The ID of the server group.

8834224
GroupFlaginteger

The type of the server group. Valid values:

  • 0: default group
  • 1: other groups
1

Examples

Sample success responses

JSONformat

{
  "Count": 2,
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
  "Groups": [
    {
      "GroupName": "abc",
      "GroupId": 8834224,
      "GroupFlag": 1
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-12-23API Description Update. The API operation is not deprecated.. The Error code has changedView Change Details