加速域名列表查询

最近更新时间:2019-05-23 17:17:13

接口描述

本接口( GetDsaHostList )用于查询账号下所有 DSA 加速域名的列表。
接口请求域名:dsa.api.qcloud.com

注意:

该接口调用频次上限为100次/分钟,超出上限则会返回错误,请勿高频调用。

输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上 公共请求参数,见公共请求参数页面。其中,此接口的 Action 字段为GetDsaHostList。

参数名称 必选 类型 描述
offset Unsigned 偏移长度,默认0,表示不偏移。
length Unsigned 最大长度,默认3000,表示最多返回3000个域名信息。
includeDeleted Int 是否包括已删除域名,默认0,表示不包括删除域名。

注意:

  • 该接口每次最多可查询3000个域名信息。
  • 当查询的域名较多时,可以利用 offset 和 length 进行分页查询。

输出参数

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详见错误码页面的 公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误信息,或业务侧错误码。
data Object 结果数据,详细说明见下文 data 字段说明

data 字段说明

参数名称 类型 描述
hosts Object 域名详细信息,详细字段见下文 hosts 字段说明
total Int 账户下域名总数。

hosts 字段说明

参数名称 类型 描述
host_id Int 域名接入 DSA 后的标识 ID。
app_id Int 域名归属人的 AppID。
project_id Unsigned 域名所属的项目 ID。
host String 加速域名。
cname String 域名接入 DSA 的 Cname 别名。
status String 域名当前状态,online:启用,offline:关闭。
progress Int 配置部署状态,0:表示部署完毕,1:表示正在部署中。
mode Int 域名封禁状态,0:表示域名未被封禁。
locked Int 运维锁状态,0:表示未锁定,用户可直接修改配置,1:表示锁定状态,需要提交工单修改配置。
deleted Int 配置存在状态,0:表示配置未删除,1:表示配置已删除。
message String 信息描述。

代码示例

配置需求示例

获取该账户下所有域名列表。

GET 请求

https://dsa.api.qcloud.com/v2/index.php?
Action=GetDsaHostList   
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXX   
&Timestamp=1462440051   
&Nonce=123456789   
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXX 
&offset=0
&length=2048 
&includeDeleted=1

POST请求

POST请求时,参数填充在HTTP Request-body 中,请求地址:

https://dsa.api.qcloud.com/v2/index.php  

参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:

array (
  'Action' => 'GetDsaHostList',
  'SecretId' => 'SecretId',
  'Timestamp' => 1462782282,
  'Nonce' => 123456789,
  'Signature' => 'Signature',
  'offset' => '0''length' => '2048''includeDeleted' => '1'
)

返回结果示例

查询成功

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "hosts": [
            {
                 "host_id": "******",
                "app_id": "******",
                "project_id": 0,
                "host": "dsatest.qcloud.com",
                "cname": "dsatest.qcloud.com.dsa.dnsv1.com",
                "status": "online",
                "deleted": 0,
                "message": ""
            },
            {
                "host_id": "******",
                "app_id": "******",
                "project_id": 0,
                "host": "dsatest2.qcloud.com",
                "cname": "dsatest2.qcloud.com.dsa.dnsv1.com",
                "status": "offline",
                "deleted": 0,
                "message": ""
            }
        ],
        "total": 2
    }
}

查询失败

{
    "code": 4100,
    "message": "鉴权失败,请参考文档中鉴权部分。",
    "codeDesc": "AuthFailure"
}