tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteDomainBatch

Last updated: 2023-03-20 11:02:15

1. API Description

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

This API is used to batch delete domains.

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: DeleteDomainBatch.
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.
DomainList.N Yes Array of String The domain array.

3. Output Parameters

Parameter Name Type Description
JobId Integer The task ID.
DetailList Array of DeleteDomainBatchDetail The array of task details.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Bulk deleting domains

This example shows you how to bulk delete domains.

Input Example

POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteDomainBatch
<Common request parameters>

{
    "DomainList": [
        "sdfsdfsdf.com"
    ]
}

Output Example

{
    "Response": {
        "DetailList": [
            {
                "Domain": "yyds999.com",
                "DomainId": 12620607,
                "Error": null,
                "Operation": "remove",
                "Status": "waiting"
            }
        ],
        "JobId": 1703509,
        "RequestId": "5090a972-50ca-4be9-abf3-a1f90e8db36c"
    }
}

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.UnknowError The operation has no response. Try again later.
InvalidParameter.BatchRecordRemoveActionError Failed to batch delete records. Cause: Internal error.
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.DomainsEmpty No domains have been submitted.
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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy