tencent cloud



Last updated: 2022-08-10 15:13:29

    1. API Description

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

    This API is used to modify a record.

    A maximum of 500 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: ModifyRecord.
    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
    RecordType Yes String Record type, which is obtained through the record type API. The value contains uppercase letters, such as A.
    RecordLine Yes String Record split zone, which is obtained through the record split zone API.
    Value Yes String Record value, such as IP :, CNAME : cname.dnspod.com, and MX : mail.dnspod.com.
    RecordId Yes Integer Record ID.
    DomainId No Integer Domain ID. The DomainId parameter has a higher priority than Domain. If DomainId is passed in, Domain will be ignored.
    SubDomain No String Host record such as www. If it is not passed in, it will be @ by default.
    RecordLineId No String Split zone ID, which is obtained through the record split zone API. The value is a string such as 10=1. The RecordLineId parameter has a higher priority than RecordLine. If both of them are passed in, RecordLineId will be used first.
    MX No Integer MX priority, which is required for an MX record and will take effect if the record type is MX. Value range: 1–20.
    TTL No Integer TTL. Value range: 1–604800. The minimum value varies by domain level.
    Weight No Integer Weight information, which is an integer between 0 and 100. It is supported only for enterprise VIP domains. 0 indicates not to pass in this parameter, i.e., not to set the weight.
    Status No String Initial status of the record. Valid values: ENABLE, DISABLE. Default value: ENABLE. If DISABLE is passed in, the DNS record won't take effect, and the limit on round-robin DNS won't be verified.

    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 Adding a record

    Input Example

    POST / HTTP/1.1
    Host: dnspod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyRecord
    <Common request parameters>
      "Domain": "dnspod.site",
      "DomainId": 62,
      "SubDomain": "bbbb",
      "RecordType": "A",
      "RecordLine": "Default",
      "RecordLineId": "0",
      "Value": "",
      "MX": 0,
      "TTL": 600,
      "Weight": 10,
      "Status": "DISABLE",
      "RecordId": 162

    Output Example

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

    5. Developer Resources


    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.AccountIsBanned Your account is banned by the system. Please contact us if you have any questions.
    InvalidParameter.CustomMessage Custom error message.
    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.InvalidWeight The weight is invalid. Enter an integer between 0 and 100.
    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.MxInvalid The MX priority is incorrect.
    InvalidParameter.RecordIdInvalid The record number is incorrect.
    InvalidParameter.RecordLineInvalid The record split zone is incorrect.
    InvalidParameter.RecordTypeInvalid The record type is incorrect.
    InvalidParameter.RecordValueInvalid The record value is incorrect.
    InvalidParameter.RecordValueLengthInvalid The DNS record value is too long.
    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.RecordTtlLimit The TTL value of the record 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.IPInBlacklistNotAllowed Sorry, you cannot add a blocked IP.
    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.
    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