DescribeDomains

1. 接口描述

调用本接口用于查询多个加速域名的信息。用户可以根据ID、名称等条件来查询。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

domainIds

Array of String

加速域名ID。

最多支持100个ID查询。

domainName

String

加速域名名称

domainStatus

String

configStatus

String

accelerationRegionId

String

businessTypeId

String

resourceGroupId

String

资源组的ID。

如果不传,则返回该用户可见的所有资源组内的实例。

pageSize

Integer

返回的分页大小。

默认为20,最大为1000。

pageNum

Integer

返回的分页数。

默认为1。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 requestId。

totalCount

Integer

符合条件的数据总数。

dataSet

结果集。

4. 代码示例

  1. 分页查询加速域名列表

POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/cdn
Content-Type: application/json
X-ZC-Action: DescribeDomains
<Common Request Params>

Request:
{
  "pageNum": 1,
  "pageSize": 1
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "totalCount": 6,
    "dataSet": [
          {
            "domainId": "domainIdxxxxx",
            "businessType": "LF",
            "domainName": "cdntest.zenlayer.com",
            "domainStatus": "DEPLOYED",
            "configStatus": "ENABLED",
            "cname": "xxx.zga.globalconnetct.com",
            "createTime": "2023-04-28T03:38:53Z",
            "resourceGroupId":"xxx-xx"
          }
    ]
  }
}

5. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

最后更新于