tencent cloud

Feedback

UpdateProhibitionIntlBatch

Last updated: 2023-03-28 10:53:01

1. API Description

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

This API is used to bulk set update prohibition for 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: UpdateProhibitionIntlBatch.
Version Yes String Common Params. The value used for this API: 2018-08-08.
Region No String Common Params. This parameter is not required for this API.
Domains.N Yes Array of String The domain array.
Status Yes Boolean Whether to enable update prohibition. Valid values: true (enable), false (disable).

3. Output Parameters

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

4. Example

Example1 Bulk setting update prohibition

Input Example

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

{
    "Domains": [
        "xx"
    ],
    "Status": true
}

Output Example

{
    "Response": {
        "LogId": 111,
        "RequestId": "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
InternalError.DescribeDomainInfoErr Failed to query the domain information.
InternalError.ForbiddenRequest Forbidden request.
InternalError.MethodNotMatch Method mismatch.
InternalError.ReadBodyError Failed to read the body.
InternalError.SetUpdateProhibitedErr Failed to cancel update prohibition for domains.
InvalidParameterValue.InvalidParameterFormat Invalid parameter value.
MissingParameter.ActionNotFound The route is not defined.
ResourceUnavailable.DomainIsModifyingDNS Unable to perform this operation because an operation of the same type is in progress for this domain.