tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyZoneStatus

Last updated: 2024-04-09 10:25:32

    1. API Description

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

    This API is used to change the site status.

    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: ModifyZoneStatus.
    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 The site ID.
    Paused Yes Boolean The site status. Values:
  • false: Disabled
  • true: Enabled
    		•

    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 Changes the site status

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyZoneStatus
<Common request parameters>

{
    "Paused": true,
    "ZoneId": "zone-27q0p0bali16"
}

    Output Example

    {
    "Response": {
        "RequestId": "7sd20b24-7dc5-98f4-96ce-95825dcd34sa"
    }
}

    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
    OperationDenied Operation denied.
    OperationDenied.ConfigLocked The configuration is locked. Please unlock and try again.
    OperationDenied.DisableZoneNotCompleted The EdgeOne service of the site is being disabled. Please try again later.
    OperationDenied.L4ProxyInProgressStatus The EdgeOne service cannot be disabled for the site: A L4 proxy instance is being deployed.
    OperationDenied.L4ProxyInStoppingStatus Unable to disable the site: There are L4 proxy instances disabled.
    OperationDenied.L7HostInProcessStatus The EdgeOne service cannot be disabled for the site: An accelerated domain name is being deployed.
    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.
    ResourceInUse The resource is occupied.
    ResourceNotFound The resource doesn’t exist.
    ResourceUnavailable The resource is unavailable.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy