接口描述
本接口( OfflineDsaHost )用于关闭指定域名的 ECDN 加速服务。
接口请求域名:dsa.api.qcloud.com
1)使用该接口,一次仅允许关闭一个域名;
2)域名关闭后,Cname 域名解析会改回源站,HOST 访问到 CDN 节点的请求会统一返回 404;
3)该接口调用频次上限为100次 / 分钟,超出上限则会返回错误,请勿高频调用。
输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上 公共请求参数,见公共请求参数页面。其中,此接口的 Action 字段为 OfflineDsaHost。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
hostId | 是 | Unsigned | 域名接入 ECDN 后的标识 ID,可通过查询域名列表信息接口获取 |
输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0 表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 模块错误信息描述,与接口相关 |
codeDesc | String | 英文错误信息,或业务侧错误码。 |
示例
1. 配置需求示例
关闭 dsa.qcloud.com 域名的 ECDN 加速服务:
host:dsa.qcloud.com
hostId:1234
2. GET 请求
GET请求需要将所有参数都加在URL后:
https://dsa.api.qcloud.com/v2/index.php?
Action=OfflineDsaHost
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1462440051
&Nonce=123456789
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXX
&hostId=1234
3. POST 请求
POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://dsa.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array (
'Action' => 'OfflineDsaHost',
'SecretId' => 'SecretId',
'Timestamp' => 1462782282,
'Nonce' => 123456789,
'Signature' => 'Signature',
'hostId' => 1234
)
4. 返回结果示例
关闭成功
{
"code": 0,
"message": "",
"codeDesc": "Success"
}
关闭失败
{
"code": 4000,
"message": "请求失败,参数[hostId]不能为空。",
"codeDesc": "InvalidParameter"
}