禁用单加速域名
更新时间：2023-03-21 10:43:42
适用产品
网页加速、下载分发、动态加速、全站加速、点播分发、直播分发、上传加速、移动加速、上网加速、S-P2P、PCDN、应用性能管理、WEB应用防火墙、BotGuard爬虫管理、WSS、DMS、DDoS云清洗、应用加速、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案
接口描述
禁用指定加速域名，禁用后加速域名的请求将被直接拒绝，不会回源。
- 调用URL： https://open.chinanetcenter.com/api/domain/*/disable
- 调用方法：PUT
- 限制说明：·禁用该加速域名后，该加速域名的配置信息仍保留，但针对加速域名的请求将被直接拒绝，不会回源。 ·禁用加速域名后，域名的enabled状态变更为false。 ·若暂时不需要对某域名进行加速，推荐使用另外一个【单域名取消CDN加速服务】接口，暂停域名加速效果。 ·在禁用加速域名后，可以启用加速域名，启用后，域名的ID和配置信息与禁用前保持一致。
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Path 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
domainId | Integer | 是 | 加速域名在系统中对应的ID 1. 参看请求示例中的url，123344对应的就是domain-id 2. 可以通过【获取域名配置】和【获取域名列表】接口查询到domain-id |
返回参数
Body 参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
code | String | 错误代码，当HTTPStatus不为202时出现，表示当前请求调用的错误类型 |
message | String | 响应信息，成功时为success |
http status code | Integer | httpstatus=202; 表示成功调用新增域名接口，可使用header中的x-cnc-request-id查看当前新增域名的部署情况 |
x-cnc-request-id | String | 唯一标示的id，用于查询每次请求的任务 （适用全部接口） |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| NoSuchDomain | The specified domain does not exist. | 400 | 指定的域名不存在 |
| DomainNotEnabled | The domain you are trying to disable has not been enabled. | 409 | 您要禁用的域名还未启用 |
| WRONG_OPERATOR | Operator [$operator] can not deal with domain name [$domainName]. | 400 | 提交人不能操作域名 |
| PARAM_INVALID | param: {0} is null or invalid. | 400 | 参数{0}为空或非法 |
| InvalidParameter | No domain was specified. | 400 | id或者域名没有传入 |
| CustomerNoOwnDomain | customer not own domain name[{0}] | 400 | 域名不属于该客户 |
示例
XML
- 请求示例 复制成功
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://open.chinanetcenter.com/api/domain/123344/disable" \ -X "PUT" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/xml"
- 返回示例 复制成功
HTTP/1.1 202 Accepted Date: Fri, 17 May 2017 06:33:26 GMT Content-Type: application/xml;charset=utf-8 x-cnc-request-id:c54cbbb4-19fe-407a-930c-3988b62ed2fd <?xml version="1.0" encoding="UTF-8"?> <response> <message>success</message> </response>
本篇文档内容对您是否有帮助？
有帮助
我要反馈