接口描述
本接口(GetDsaHostInfo)用于根据域名 ID 查询域名配置信息。
接口请求域名:dsa.api.qcloud.com
注意:
- 使用此接口,一次仅支持查询一个域名的配置信息。
- 该接口调用频次上限为100次/分钟,超出上限则会返回错误,请勿高频调用。
输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为 GetDsaHostInfo。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
hostId | 是 | Unsigned | 域名接入 ECDN 后的标识 ID。 |
注意:域名对应的 hostId 可通过 查询域名列表信息 接口获取。
输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 英文错误信息,或业务侧错误码。 |
data | Object | 域名详细信息。 |
data 字段说明
参数名称 | 类型 | 描述 |
---|---|---|
host_id | Int | 域名接入 ECDN 后的标识 ID。 |
app_id | Int | 域名归属人的 AppID。 |
project_id | Unsigned | 域名所属的项目 ID。 |
host | String | 加速域名 |
cname | String | 域名接入 ECDN 的 CNAME 别名。 |
status | String | 域名当前状态,online:启用,offline:关闭。 |
progress | Int | 配置部署状态,0:表示部署完毕,1:表示正在部署中。 |
mode | Int | 域名封禁状态,0:表示域名未被封禁。 |
locked | Int | 运维锁状态,0:表示未锁定,用户可直接修改配置,1:表示锁定状态,需要提交工单审核后才能修改配置。 |
deleted | Int | 域名是否删除,0:表示域名未删除,1:表示域名已删除。 |
origin | String | 源站地址。 |
fwd_host | String | 回源 host 配置。 |
rsp_header | Array | 自定义返回头部配置信息。 |
https | Object | HTTPS 配置信息,详情见下文 HTTPS 字段说明。 |
message | String | 信息描述。 |
create_time | String | 域名创建时间。 |
update_time | String | 域名上一次配置更新时间。 |
HTTPS 字段说明
参数名称 | 类型 | 描述 |
---|---|---|
type | Unsigned | HTTPS 开关,0:表示关闭,2:表示启用,并且采用 HTTP 回源,4:表示启用,并采用协议跟随回源。 |
cert_id | String | 腾讯云托管证书 ID,当使用腾讯云托管证书时返回此参数。 |
cn | String | 证书域名。 |
expire | String | SSL 证书过期时间。 |
message | String | 证书备注信息。 |
http2 | String | HTTP 2.0 开关,on:表示开启,off:表示关闭。 |
注意:未在上述文档中说明的字段为无效字段,可直接忽略。
代码示例
配置示例
查询 dsa.qcloud.com
域名的 ECDN 加速配置信息,域名信息:
host:dsa.qcloud.com
hostId:1234
GET 请求
GET 请求需要将所有参数都加在 URL 后:
https://dsa.api.qcloud.com/v2/index.php?
Action=GetDsaHostInfo
&SecretId=XXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1519886766
&Nonce=21561
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&hostId=1234
POST 请求
POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://dsa.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array (
'Action' => 'GetDsaHostInfo',
'SecretId' => 'SecretId',
'Timestamp' => 1519886766,
'Nonce' => 21561,
'Signature' => 'Signature',
'hostId' => '1234'
)
返回结果示例
查询成功
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"host_id": 1234,
"app_id": "*******",
"project_id": 0,
"host": "dsa.qcloud.com",
"cname": "dsa.qcloud.com.dsa.dnsv1.com",
"status": "offline",
"progress": 0,
"mode": 0,
"locked": 0,
"deleted": 0,
"origin": "origin.dsa.qcloud.com",
"fwd_host": "dsa.qcloud.com",
"rsp_header": [],
"https": {"type": 0},
"message": "",
"create_time": "2017-11-17 11:07:08",
"update_time": "2017-11-17 12:52:02"
}
}
查询失败
{
"code": 4000,
"message": "(2000)加速域名不存在",
"codeDesc": "InvalidParameter"
}