tencent cloud



Last updated: 2022-08-10 15:12:56

    1. API Description

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

    This API is used to set the remarks of a domain.

    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: ModifyDomainRemark.
    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
    DomainId No Integer Domain ID. The DomainId parameter has a higher priority than Domain. If DomainId is passed in, Domain will be ignored.
    Remark No String Domain remarks. To delete the remarks, submit empty content.

    3. Output Parameters

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

    4. Example

    Example1 Setting the remarks of a domain

    Input Example

    POST / HTTP/1.1
    Host: dnspod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyDomainRemark
    <Common request parameters>
      "Domain": "dnspod.site",
      "DomainId": 62,
      "Remark": "This is the dedicated domain of XXX"

    Output Example

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

    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.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.LoginTokenIdError The token ID is incorrect.
    InvalidParameter.LoginTokenNotExists The token passed in does not exist.
    InvalidParameter.LoginTokenValidateFailed Failed to verify the token.
    InvalidParameter.RemarkTooLong The remarks are too long (max 200 characters).
    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.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