文档

QueryDomainGroupList - 查询域名分组列表

更新时间:

调用QueryDomainGroupList查询域名分组列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Langstring

接口返回错误信息语言。取值:

  • zh:中文;
  • en:英文。

默认为 en

en
UserClientIpstring

用户 IP,可以设置为127.0.0.1

127.0.0.1
DomainGroupNamestring

用户自定义的域名分组名称。

默认分组
ShowDeletingGroupboolean

是否展示正在删除中的域名分组,取值如下:

  • false:否。
  • true:是。

默认为 false

false

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求标识码。

80011ABC-F573-4795-B0E8-377BFBBA3422
Dataobject []

域名分组列表。

BeingDeletedboolean

是否正在删除中。超过 1000 个域名的分组删除为异步过程,需要系统处理一段时间,在此期间内该字段为 true

false
DomainGroupStatusstring

域名分组状态。取值:

  • PROCESSING:处理中;
  • COMPLETE:已完成。
说明 通过文件设置分组、替换超过 1000 个域名的分组等情况下为异步过程,需要等待系统处理,此状态下该字段为 PROCESSING
COMPLETE
DomainGroupIdstring

域名分组编号。

-1
DomainGroupNamestring

域名分组名称。

未分组
ModificationDatestring

域名分组修改时间。

2018-04-02 15:59:06
TotalNumberinteger

域名数量。

20
CreationDatestring

域名分组创建时间。

2018-04-02 15:59:06

示例

正常返回示例

JSON格式

{
  "RequestId": "80011ABC-F573-4795-B0E8-377BFBBA3422",
  "Data": {
    "DomainGroup": [
      {
        "BeingDeleted": false,
        "DomainGroupStatus": "COMPLETE",
        "DomainGroupId": "-1",
        "DomainGroupName": "未分组",
        "ModificationDate": "2018-04-02 15:59:06",
        "TotalNumber": 20,
        "CreationDate": "2018-04-02 15:59:06"
      }
    ]
  }
}

JSON格式

{
  "RequestId": "80011ABC-F573-4795-B0E8-377BFBBA3422",
  "Data": {
    "DomainGroup": [
      {
        "BeingDeleted": false,
        "DomainGroupStatus": "COMPLETE",
        "DomainGroupId": "-1",
        "DomainGroupName": "未分组",
        "ModificationDate": "2018-04-02 15:59:06",
        "TotalNumber": 20,
        "CreationDate": "2018-04-02 15:59:06"
      }
    ]
  }
}

错误码

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

  • 本页导读 (1)
文档反馈