tencent cloud

Feedback

ModifyZoneStatus

Last updated: 2023-03-09 17:41:36

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-01-06.
Region No String Common Params. This parameter is not required for this API.
Id Yes String Site ID
Paused Yes Boolean Site status.
- false: Enable the site.
- true: Disable the site.

3. Output Parameters

Parameter Name Type Description
Id String Site ID
Name String Site name
Paused Boolean Site status.
- false: Enable the site.
- true: Disable the site.
ModifiedOn Timestamp ISO8601 Update time
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Changing 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,
    "Id": "xx"
}

Output Example

{
    "Response": {
        "Paused": true,
        "ModifiedOn": "2020-09-22T00:00:00+00:00",
        "Name": "xx",
        "RequestId": "xx",
        "Id": "xx"
    }
}

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
ResourceNotFound The resource doesn’t exist.
ResourceUnavailable The resource is unavailable.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support