tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyAccelerationDomainStatuses

Last updated: 2024-12-03 16:18:01

    1. API Description

    Domain name for API request: teo.intl.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 Name Required Type Description
    Action Yes String Common Params. The value used for this API: ModifyAccelerationDomainStatuses.
    Version Yes String Common Params. The value used for this API: 2022-09-01.
    Region No String Common Params. This parameter is not required.
    ZoneId Yes String ID of the site related with the accelerated domain name.
    DomainNames.N Yes Array of String List of accelerated domain names to be modified.
    Status Yes String Status of the accelerated domain name. Values:
  • online: Enabled
  • offline: Disabled
    		•
    Force No Boolean Whether 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 Name Type Description
    RequestId String The 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.intl.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 Code Description
    FailedOperation Operation failed.
    InternalError.SystemError Internal system error.
    InvalidParameter.ErrInvalidActionParamValue Invalid action.
    InvalidParameter.InvalidErrorPage Invalid custom error page.
    InvalidParameter.InvalidServerName Invalid origin domain.
    InvalidParameter.ZoneIsGrayPublishing The site is being upgraded. Changing is not supported. Please try again later.
    InvalidParameterValue.DomainNotMatchZone The specified domain name does not match the site.
    OperationDenied Operation denied.
    OperationDenied.ConfigLocked The configuration is locked. Please unlock and try again.
    OperationDenied.ErrZoneIsAlreadyPaused The EdgeOne service of the site is disabled. Please enable it and try again.
    OperationDenied.ResourceLockedTemporary This operation conflicts with concurrent operations. Try again later.
    OperationDenied.VersionControlIsGraying There 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.VersionControlLocked The operation is not allowed because the version management mode is applied.
    ResourceInUse The resource is occupied.
    ResourceUnavailable.DomainNotFound The requested accelerated domain name doesn’t exist.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    UnauthorizedOperation.Unknown An unknown error occurred in the backend server.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy