Domain name for API request: dnspod.tencentcloudapi.com.
This API is used to set the remarks of a record.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyRecordRemark. |
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. |
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. |
Remark | No | String | DNS record remarks. To delete the remarks, submit empty content. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRecordRemark
<Common request parameters>
{
"Domain": "dnspod.site",
"DomainId": 62,
"RecordId": 162,
"Remark": "It is the remarks of the DNS record"
}
{
"Response": {
"RequestId": "ab4f1426-ea15-42ea-8183-dc1b44151166"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.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.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.LoginTokenIdError | The token ID is incorrect. |
InvalidParameter.LoginTokenNotExists | The token passed in does not exist. |
InvalidParameter.LoginTokenValidateFailed | Failed to verify the token. |
InvalidParameter.RecordIdInvalid | The record number is incorrect. |
InvalidParameter.RemarkLengthExceeded | The length of the remarks exceeds the limit. |
InvalidParameter.RequestIpLimited | Your IP is invalid, so the request was rejected. |
InvalidParameter.UnrealNameUser | Your account identity has not been verified. Complete identity verification first before performing this operation. |
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.FailedLoginLimitExceeded | Your account has been banned by the system due to excessive failed login attempts. |
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. |
Was this page helpful?