Overview
Menu

ModifyAccelerationDomainStatuses

1. API Description

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

This API is used to batch modify the status of accelerated domains.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: ModifyAccelerationDomainStatuses.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringID of the site related with the accelerated domain name.
DomainNames.NYesArray of StringList of accelerated domain names to be modified.
StatusYesStringStatus of the accelerated domain name. Values:
  • online: Enabled
  • offline: Disabled
  • ForceNoBooleanWhether to force suspension when the domain name has associated resources (such as alias domain names and traffic scheduling policies). Values:
  • true: Suspend the domain name and all associated resources.
  • true: Do not suspend the domain name and all associated resources.
  • Default value: false.

    3. Output Parameters

    Parameter NameTypeDescription
    RequestIdStringThe unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Batch modifying the status of accelerated domains

    The following example shows how to disable a specified acceleration domain name.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyAccelerationDomainStatuses
    <Common request parameters>
    {
        "DomainNames": [
            "example.com"
        ],
        "ZoneId": "zone-225qgrnvbi9w",
        "Status": "offline",
        "Force": "false"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"
        }
    }
    

    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 CodeDescription
    FailedOperationOperation failed.
    InternalError.SystemErrorInternal system error.
    InvalidParameter.ErrInvalidActionParamValueInvalid action.
    InvalidParameter.InvalidErrorPageInvalid custom error page.
    InvalidParameter.InvalidServerNameInvalid origin domain.
    InvalidParameter.ZoneIsGrayPublishingThe site is being upgraded. Changing is not supported. Please try again later.
    InvalidParameterValue.DomainNotMatchZoneThe specified domain name does not match the site.
    OperationDeniedOperation denied.
    OperationDenied.ConfigLockedThe configuration is locked. Please unlock and try again.
    OperationDenied.ErrZoneIsAlreadyPausedThe EdgeOne service of the site is disabled. Please enable it and try again.
    OperationDenied.ResourceLockedTemporaryThis operation conflicts with concurrent operations. Try again later.
    OperationDenied.VersionControlIsGrayingThere is a test version in use. Please release the test version to the live environment, or roll back the test version and try again.
    OperationDenied.VersionControlLockedThe operation is not allowed because the version management mode is applied.
    ResourceInUseThe resource is occupied.
    ResourceUnavailable.DomainNotFoundThe requested accelerated domain name doesn’t exist.
    UnauthorizedOperation.CamUnauthorizedCAM is not authorized.
    UnauthorizedOperation.UnknownAn unknown error occurred in the backend server.