All Products
Search
Document Center

Alibaba Cloud DNS:DescribeDomainGroups

Last Updated:Feb 21, 2024

Queries all domain name groups based on the specified parameters.

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
alidns:DescribeDomainGroupsREAD
  • group
    acs:alidns:*:{#accountId}:group/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language.

en
KeyWordstringNo

The keyword of the domain name group for searches in %KeyWord% mode. The value is not case-sensitive.

Group
PageNumberlongNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizelongNo

The number of entries per page. Valid values: 1 to 100. Default value: 20.

20

Response parameters

ParameterTypeDescriptionExample
object
DomainGroupsobject []

The domain name groups.

GroupIdstring

The ID of the domain name group. Valid values:

  • defaultGroup: the default group
  • If an empty string is returned, it indicates the group that contains all domain names.
2223
GroupNamestring

The name of the domain name group.

MyGroup
DomainCountlong

The number of domain name groups.

2
TotalCountlong

The total number of entries returned.

1
PageSizelong

The number of entries per page. Valid values: 1 to 100. Default value: 20.

20
RequestIdstring

The request ID.

536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumberlong

The page number. Pages start from page 1. Default value: 1.

1

Examples

Sample success responses

JSONformat

{
  "DomainGroups": {
    "DomainGroup": [
      {
        "GroupId": "2223",
        "GroupName": "MyGroup",
        "DomainCount": 2
      }
    ]
  },
  "TotalCount": 1,
  "PageSize": 20,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history