启动CDN域名

最近更新时间:2018-05-09 14:44:47

接口描述

OnlineHost 启动指定域名的加速服务。

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

注意事项:

  • 一次支持一个域名的启动操作
  • 仅当域名状态为【已关闭】时,才可进行启动操作
  • 调用频次限制为 100次/分钟
  • 接口已支持子账号调用,权限配置可参考权限配置示例

查看调用示例

入参说明

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

参数名称 是否必选 类型 描述
host String 需要启动的加速域名
hostId Int 需要启动的加速域名 ID

详细说明

出参说明

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

调用案例

示例参数

hostId:1234

GET 请求

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

https://cdn.api.qcloud.com/v2/index.php?
Action=OnlineHost
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1462436277
&Nonce=123456789
&Signature=XXXXXXXXXXXXXXXXXXXXX
&hostId=1234

POST 请求

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

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

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

array (
  'Action' => 'OnlineHost',
  'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  'Timestamp' => 1462782282,
  'Nonce' => 123456789,
  'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
  'hostId' => 1234
)

结果示例

{
    "code": 0,
    "message": "",
    "codeDesc": "Success"
}
{
    "code": 4000,
    "message": "(9177)域名已上线 cdn host online[host online]",
    "codeDesc": 9177
}