1. 接口描述
本接口(GetCdnOvHostInfo)用于查询某个境外 CDN 域名的详细信息。
接口请求域名:
cdn.api.qcloud.com
2. 输入参数
参数名称 | 是否必选 | 类型 | 描述 |
hostId | 否 | Int | 境外 CDN 域名 ID。 |
host | 否 | String | 境外 CDN 域名。 |
Note:
hostId 和 host 必需至少指定一项,两者都指定的情况下只会查询 hostId 对应的域名。
3. 输出参数
参数名称 | 类型 | 描述 |
code | Int | |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 英文错误信息,或业务侧错误码。 |
data | Array | 结果数据,详细说明见下文 data 字段说明。 |
data 字段说明
参数名称 | 类型 | 描述 |
app_id | Int | |
host_id | Int | 境外域名 ID。 |
project_id | Int | 域名所属的项目 ID。 |
host | String | 域名。 |
cname | String | CDN 分配的 .cdn.dnsv1.com 后缀加速域名。 |
host_type | String | 接入方式,共有三种类型,若为 'cos',则表示域名接入时使用的托管源为COS源;若为'cname',则表示域名接入时使用的是自有源站;若为'ftp',则表示该域名接入时使用了 CDN 提供的 FTP 托管源。 |
service_type | String | 域名业务类型,共有三种类型,若为 'web',则表示类型为静态加速;若为 'download',则表示业务类型为下载加速;若为 'media',则表示业务类型为流媒体加速。 |
status | Int | 域名 CDN 服务状态码。 |
cdn_status | String | 域名 CDN 服务状态。 |
origin | String | 域名对应源站配置。 |
fwd_host | String | 回源地址。 |
refer | String | |
cache | String | |
furl_cache | String | 过滤参数,若为'on',则表示开启;若为'off',则表示关闭。 |
rsp_header | String | 自定义返回头部。 |
https | Array | 若 type 为0,则表示未开通 HTTPS 配置;若为其他,则表示已开通 HTTPS 配置。 |
readonly | Int | 当前是否被锁定,0表示未被锁定,1表示被锁定。 |
deleted | String | 'yes' 或是 'no',表示域名是否标记为已删除。 |
message | String | 域名状态的描述信息。 |
create_time | String | CDN 服务创建时间。 |
update_time | String | CDN 服务的最近更新时间。 |
middle_resource | String | 'on'或是'off',表示是否开启了中间源。 |
cache 字段说明
参数名称 | 类型 | 描述 |
type | Int | 类型,共有两种类型,其中0表示配置为所有文件,1表示配置为文件类型。 |
rule | String | 匹配规则,与上述 type 相对应。 |
time | Int | 缓存时间,单位:秒。 |
unit | String | 设置缓存时间时所用单位,共有四种类型,'d'表示天,'h'表示小时,'m'表示分钟,'s'表示秒。 |
refer 字段说明
参数名称 | 类型 | 描述 |
type | Int | 防盗链类型,共有三种类型,0表示未配置防盗链,1表示配置的名单为黑名单,2表示配置的名单为白名单。 |
list | Array | 配置的防盗链名单。 |
Note:
未在上述文档中说明的字段为无效字段,可直接忽略。
4. 示例
4.1 输入示例
hostId : 11111111
4.2 GET 请求
GET 请求需要将所有参数都加在 URL 后:
https://cdn.api.qcloud.com/v2/index.php?Action=GetCdnOvHostInfo&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX&Timestamp=1462434006&Nonce=123456789&Signature=XXXXXXXXXXXXXXXXXXXXX&hostId=11111111
4.3 POST 请求
POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://cdn.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array ('Action' => 'GetCdnOvHostInfo','SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX','Timestamp' => 1462782282,'Nonce' => 123456789,'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX','hostId' => '11111111',)
4.4 返回结果示例
{"code": 0,"message": "","codeDesc": "Success","data": {"host_id": 11111111,"app_id": 12345678,"project_id": 0,"host": "www.test.com","cname": "www.test.com.cdn.dnsv1.com","host_type": "cname","service_type": "download","status": 4,"cdn_status": "progress","origin": "8.8.8.8","fwd_host": "www.test.com","refer": {"type": 2,"list": ["1.1.1.1"]},"cache": [{"type": 0,"rule": "all","time": 2592000,"unit": "d"},{"type": "1","rule": ".jpg;.png;.css;.js","time": 86400,"unit": "d"}],"furl_cache": "off","rsp_header": [],"https": {"type": 0},"readonly": 0,"deleted": "no","message": "部署中","create_time": "2017-08-08 11:27:59","update_time": "2017-08-08 12:19:11","middle_resource": "off"}}