DisableSingleDomainService
Update time: 2026-08-14 11:27:43
Applicable Products
Content Acceleration,Dynamic Web Acceleration,Media Acceleration VoD,Media Acceleration Live Broadcast
API Description
Disables the specified accelerated domain name, and requests for the accelerated domain name after it is disabled will be rejected directly and will not be back to origin.
- API URL: https://api.atomile.com/api/domain/*/disable
- Method: PUT
- Limit Description: · After disabling the accelerated domain name, the configuration information of the accelerated domain name will remain, but the request for the accelerated domain name will be directly rejected and will not be returned. · After disabling the accelerated domain name, the enabled state of the domain name is changed to false. · If you do not need to speed up a domain name for the time being, it is recommended to use another [CancelApiDomainService] interface to suspend the domain name acceleration effect. · After disabling the accelerated domain name, you can enable the accelerated domain name. When enabled, the domain name ID and configuration information are the same as before the disabling.
Call frequency
Single user trigger frequency: 300/5min
Request parameter(s)
Path Params
| Name | Description |
|---|---|
*domainString | Domain name or Domain ID |
Response parameter(s)
Response Header
| Name | Description |
|---|---|
x-cnc-request-idString | Uniquely identified id for querying tasks per request (for all API) |
Body Params
| Name | Description |
|---|---|
codeString | Error code, which appears when HTTPStatus is not 202, represents the error type of the current request call |
messageString | Response information, success when successful |
Error code
| Error code(code) | Description(message) | HTTP status | Semantic |
|---|---|---|---|
| NoSuchDomain | The specified domain name does not exist. | 400 | The specified domain name does not exist. |
| DomainNotEnabled | The domain you want to disable is not yet enabled. | 409 | The domain you want to disable is not yet enabled. |
| WRONG_OPERATOR | The author cannot operate the domain name | 400 | The author cannot operate the domain name |
| PARAM_INVALID | Parameter {0} null or illegal | 400 | Parameter {0} null or illegal |
| InvalidParameter | No domain was specified. | 400 | No domain was specified. |
| CustomerNoOwnDomain | customer not own domain name[{0}] | 400 | customer not own domain name[{0}] |
Example
JSON
- Request example Copy success
#!/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://{@apiDomain}/api/domain/123344/disable" \ -X "PUT" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json"- Response example Copy success
HTTP/1.1 202 Accepted Date: Fri, 17 May 2017 06:33:26 GMT Content-Type: application/json;charset=utf-8 x-cnc-request-id:c54cbbb4-19fe-407a-930c-3988b62ed2fd {"message":"success"}