下线境外域名

最近更新时间:2020-03-05 17:04:58

1. 接口描述

本接口(OfflineOvHost)用于下线某个境外域名的 CDN 服务。

接口请求域名:cdn.api.qcloud.com

调用Demo

2. 输入参数

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

参数名称 是否必选 类型 描述
hostId Int 境外 CDN 域名 ID

3. 输出参数

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详见错误码页面的 公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误信息,或业务侧错误码。
data Array 结果数据,默认为 null。
注意:

未在上述文档中说明的字段为无效字段,可直接忽略。

4. 示例

4.1 输入示例

hostId:11111111

4.2 GET 请求

GET 请求需要将所有参数都加在 URL 后:

https://cdn.api.qcloud.com/v2/index.php?
Action=OfflineOvHost
&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' => 'OfflineOvHost',
  'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  'Timestamp' => 1462782282,
  'Nonce' => 123456789,
  'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
  'hostId' => '11111111',
)

4.4 返回结果示例

操作成功返回示例

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": null
}

操作失败返回示例

{
    "code": 4000,
    "message": "(9110)域名不存在,请确认后重试 cdn no such host",
    "codeDesc": "UserRequestError"
}