tencent cloud

Feedback

DeleteDomain

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

    1. API Description

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

    This API is used to delete 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: DeleteDomain.
    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.

    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 Deleting the domain dnspod.com

    Input Example

    POST / HTTP/1.1
    Host: dnspod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DeleteDomain
    <Common request parameters>
    {
      "Domain": "dnspod.com"
    }
    

    Output Example

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

    Example2 Deleting the domain iceice.club

    Input Example

    POST / HTTP/1.1
    Host: dnspod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DeleteDomain
    <Common request parameters>
    {
      "Domain": "iceice.club"
    }
    

    Output Example

    {
    "Response": {
      "RequestId": "5d459ba8-f335-4508-b6b2-efed8b531c8c"
    }
    }
    

    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.DomainIsKeyDomain This domain is a key protected resource in DNSPod. To prevent the service from being affected by maloperations, you cannot delete it. If you are sure you need to delete it, please contact your sales rep for technical support.
    FailedOperation.DomainIsLocked You cannot perform this operation on a locked domain.
    FailedOperation.DomainIsSpam You cannot perform this operation on a banned domain.
    FailedOperation.DomainIsVip You cannot perform this operation on a VIP domain.
    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.DomainIdInvalid The domain number is incorrect.
    InvalidParameter.DomainInEffectOrInvalidated You cannot perform operations on a domain currently active or invalid.
    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.
    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.
    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