tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyRecordStatus

Last updated: 2023-03-20 11:02:10

1. API Description

Domain name for API request: dnspod.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: ModifyRecordStatus.
Version Yes String Common Params. The value used for this API: 2021-03-23.
Region No String Common Params. This parameter is not required for this API.
Domain Yes String Domain
RecordId Yes Integer The record ID. You can view all DNS records and their IDs via the DescribeRecordList API.
Status Yes String Record status. Valid values: ENABLE, DISABLE. If DISABLE is passed in, the DNS record won't take effect, and the limit on round-robin DNS won't be verified.
DomainId No Integer The domain ID. DomainId takes priority over Domain. If DomainId is passed in, Domain is ignored. You can view all Domain and DomainId values via the DescribeDomainList API.

3. Output Parameters

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

4. Example

Example1 Setting the record status

Input Example

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

{
    "Domain": "dnspod.site",
    "DomainId": 62,
    "RecordId": 161,
    "Status": "ENABLE"
}

Output Example

{
    "Response": {
        "RequestId": "ab4f1426-ea15-42ea-8183-dc1b44151166",
        "RecordId": 161
    }
}

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 The operation failed.
FailedOperation.DomainIsLocked You cannot perform this operation on a locked domain.
FailedOperation.DomainIsSpam You cannot perform this operation on a banned domain.
FailedOperation.LoginAreaNotAllowed The request was rejected due to an unusual login location of your account.
FailedOperation.LoginFailed Login failed. Check whether the account and password are correct.
FailedOperation.UnknowError The operation has no response. Try again later.
InvalidParameter.CustomMessage Custom error message.
InvalidParameter.DnssecAddCnameError DNSSEC has been enabled for this domain. You cannot add an @CNAME, URL, or framed URL record.
InvalidParameter.DomainIdInvalid The domain number is incorrect.
InvalidParameter.DomainInvalid The domain is incorrect. Enter a top-level domain such as dnspod.cn.
InvalidParameter.DomainIsAliaser This domain is an alias of another domain.
InvalidParameter.DomainNotAllowedModifyRecords You cannot change the DNS record of a domain currently active or invalid.
InvalidParameter.DomainNotBeian The domain does not have an ICP filing, so you cannot add a URL record for it.
InvalidParameter.DomainRecordExist The record already exists and does not need to be added again.
InvalidParameter.EmailNotVerified Sorry, the email address of your account has not been verified.
InvalidParameter.LoginTokenIdError The token ID is incorrect.
InvalidParameter.LoginTokenNotExists The token passed in does not exist.
InvalidParameter.LoginTokenValidateFailed Failed to verify the token.
InvalidParameter.MobileNotVerified Sorry, the mobile number of your account has not been verified.
InvalidParameter.RecordIdInvalid The record number is incorrect.
InvalidParameter.RecordValueInvalid The record value is incorrect.
InvalidParameter.RequestIpLimited Your IP is invalid, so the request was rejected.
InvalidParameter.SubdomainInvalid The subdomain is incorrect.
InvalidParameter.UnrealNameUser Your account identity has not been verified. Complete identity verification first before performing this operation.
InvalidParameter.UrlValueIllegal Sorry, the URL failed to be added/enabled because its content did not comply with the DNSPod Terms of Service. Please contact technical support for assistance.
InvalidParameter.UserNotExists The user does not exist.
InvalidParameterValue.DomainNotExists The current domain is incorrect. Return to the previous step and try again.
InvalidParameterValue.UserIdInvalid The user number is incorrect.
LimitExceeded.AAAACountLimit The number of AAAA records exceeds the limit.
LimitExceeded.AtNsRecordLimit The @NS record can be set to the default split zone only.
LimitExceeded.FailedLoginLimitExceeded Your account has been banned by the system due to excessive failed login attempts.
LimitExceeded.HiddenUrlExceeded The DNS plan used by this domain does not support framed URL forwarding, or the number of framed URL forward records exceeds the limit. To use this feature, please purchase more records.
LimitExceeded.NsCountLimit The number of NS records exceeds the limit.
LimitExceeded.SrvCountLimit The number of SRV records exceeds the limit.
LimitExceeded.SubdomainLevelLimit The number of subdomain levels exceeds the limit.
LimitExceeded.SubdomainRollLimit The number of round-robin DNS records of the subdomain exceeds the limit.
LimitExceeded.SubdomainWcardLimit The number of wildcard levels exceeds the limit.
LimitExceeded.UrlCountLimit The number of URL forward records of this domain exceeds the limit. To continue using this feature, please purchase more records.
OperationDenied.DomainOwnerAllowedOnly Only the domain owner can perform this operation.
OperationDenied.NoPermissionToOperateDomain You have no permission to perform operations on the current domain. Return to the domain list.
OperationDenied.NotAdmin You are not an admin.
OperationDenied.NotAgent Your are not a proxy user.
OperationDenied.NotManagedUser The user is not under your account.
RequestLimitExceeded.RequestLimitExceeded The number of API requests exceeds the limit.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy