停用加速域名--内容分发网络-火山引擎

文档中心

立即注册

导航

内容分发网络

停用加速域名

最近更新时间：2024.06.28 19:18:52首次发布时间：2021.09.16 18:02:38

通过 API 将指定加速域名的状态置为停用状态。停用域名前，请确保 CNAME 解析未配置为火山引擎提供的 CNAME 地址。

使用限制

节流限制：您每秒最多可以发送 20 个请求。

若您已经将域名从账号中删除，则无法对其进行停用操作。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=StopCdnDomain&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `StopCdnDomain`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	是	表示一个要停用的加速域名。	`www.example.com`

响应正文

由于该 API 没有响应参数，响应正文只有包含请求元数据的 ResponseMetadata 结构体，没有 Result 结构体。

请求示例

POST https://cdn.volcengineapi.com/?Action=StopCdnDomain&Version=2021-03-01
{
  "Domain": "www.example.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202109152015230101941000540700BFE4",
    "Action": "StopCdnDomain",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。