StopCdnDomain

Last updated: 2020-11-27 16:01:35

1. API Description

Domain name for API request: cdn.tencentcloudapi.com.

This API is used to suspend the acceleration service for a domain name.
Note: after the acceleration service has been suspended, requests to the cache node will return a 404 error. In order to avoid impact to your business, please move the domain name to another service before suspending the acceleration service.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: StopCdnDomain.
Version Yes String Common parameter. The value used for this API: 2018-06-06.
Region No String Common parameter. This parameter is not required for this API.
Domain Yes String Domain name
The domain name status should be Enabled

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Disabling an acceleration domain name

Input Example

https://cdn.tencentcloudapi.com/?Action=StopCdnDomain
&Domain=www.test.com
&<Common request parameter>

Output Example

{
  "Response": {
    "RequestId": "1fa8b845-ca93-457a-a776-ea7915695648"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.CdnConfigError Failed to update the domain name configuration. Please try again or contact customer service.
InternalError.CdnConfigError Failed to update the domain name configuration.
InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.CDNStatusInvalidDomain Invalid domain name status.
InvalidParameter.CdnHostHasSpecialConfig The domain name is configured with special configurations, please submit a ticket.
InvalidParameter.CdnHostInvalidStatus Invalid domain name status.
InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
LimitExceeded.CdnHostOpTooOften Domain name operations are too frequent.
ResourceInUse.CdnOpInProgress CDN resources are being operated.
ResourceNotFound.CdnHostNotExists This domain name does not exist under the account. Please check and try again.
ResourceUnavailable.CdnHostIsLocked The domain name is locked.
UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
UnauthorizedOperation.CdnHostUnauthorized The sub-account has no access to the CDN-accelerated domain name.
UnauthorizedOperation.CdnUserAuthFail Fail to authenticate the CDN user.
UnauthorizedOperation.CdnUserAuthWait The CDN user is pending authentication.
UnauthorizedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.
UnsupportedOperation.OpNoAuth This operation is not supported currently. Please submit a ticket for assistance.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help