tencent cloud



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

    1. API Description

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

    This API is used to modify the status 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: ModifyDomainStatus.
    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
    Status Yes String Domain status. Valid values: enable; disable.
    DomainId No Integer Domain ID. The DomainId parameter has a higher priority than Domain. If DomainId is passed in, Domain will be ignored.

    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 Modifying the status of a domain

    Input Example

    POST / HTTP/1.1
    Host: dnspod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyDomainStatus
    <Common request parameters>
      "Domain": "dnspod.com",
      "Status": "disable"

    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.
    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.ToolsDomainInvalid The domain is invalid.
    InvalidParameterValue.DomainNotExists The current domain is incorrect. Return to the previous step and try again.
    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.
    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