DescribeDomainGroups - 获取域名分组列表 - 云解析 DNS

根据传入参数获取域名分组的列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
alidns:DescribeDomainGroups	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	语言。	en
KeyWord	string	否	组名关键字，按照“%KeyWord%”模式搜索，不区分大小写。	Group
PageNumber	long	否	当前页数，起始值为 1，默认为 1。	1
PageSize	long	否	分页查询时设置的每页行数，最大值 100，默认为 20。	20

返回参数

名称	类型	描述	示例值
	object
DomainGroups	array<object>	域名分组结构列表。
DomainGroup	object
GroupId	string	域名分组 ID。默认分组 GroupId："defaultGroup"，代表未设置分组的域名。全部域名 GroupId：""，代表所有域名。	2223
GroupName	string	域名分组名称。	MyGroup
DomainCount	long	域名分组数量。	2
TotalCount	long	域名分组总数量。	1
PageSize	long	分页查询时设置的每页行数，最大值 100，默认为 20。	20
RequestId	string	唯一请求识别码。	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	long	当前页数，起始值为 1，默认为 1。	1

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史