tencent cloud

Feedback

ModifyRecordsStatus

Last updated: 2022-11-04 15:18:03

1. API Description

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

This API is used to modify the DNS record 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: ModifyRecordsStatus.
Version Yes String Common Params. The value used for this API: 2020-10-28.
Region No String Common Params. This parameter is not required for this API.
ZoneId Yes String The private domain ID
RecordIds.N Yes Array of Integer The DNS record IDs.
Status Yes String enabled: Enable; disabled: Disable.

3. Output Parameters

Parameter Name Type Description
ZoneId String The private domain ID
RecordIds Array of Integer The DNS record IDs.
Status String enabled: Enabled; disabled: Disabled.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the DNS record status

Input Example

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

{
    "ZoneId": "zone-mao3y9jo",
    "RecordIds": [
        1,
        2,
        3
    ],
    "Status": "enabled"
}

Output Example

{
    "Response": {
        "RequestId": "660006f4-8531-46f0-a2ba-05daf4e7932e",
        "ZoneId": "zone-mao3y9jo",
        "RecordIds": [
            1,
            2,
            3
        ],
        "Status": "enabled"
    }
}

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.ModifyRecordFailed Failed to modify the record.
InternalError Internal error.
InternalError.UndefiendError Undefined error.
InvalidParameter Incorrect parameter.
InvalidParameter.RecordNotExist The record does not exist.
InvalidParameter.ZoneNotExists The domain does not exist.
LimitExceeded.TldOutOfLimit Exceeded the custom TLD quota.
LimitExceeded.TldOutOfRange The number of private domains using the custom TLD exceeds the total quota.
ResourceUnavailable.TldPackageExpired The TLD value-added package expired.
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