tencent cloud

Feedback

DeleteTable

Last updated: 2024-09-12 11:43:43

1. API Description

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

This API is used to delete the specified table in the specified database.

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: DeleteTable.
Version Yes String Common Params. The value used for this API: 2021-12-28.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Resource ID, which is the TCHouse-D resource ID used for table creation.
DbName Yes String The name of the database where the table belongs needs to be deleted.
TableName Yes String Table name to be deleted
UserName No String Use the user who has corresponding permissions for operations. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in.
PassWord No String Password corresponding to the user. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in.
IsForce No Boolean True: The system will not check whether there are unfinished transactions in the table. The table will be deleted directly and cannot be recovered. False: The deleted table can be recovered within a period of time (default value).

3. Output Parameters

Parameter Name Type Description
Message String Error message
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Deleting Tables Under the Specified Database

This example shows you how to delete the test table under the demo database.

Input Example

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

{
    "InstanceId": "cdwdoris-bjizjxxx",
    "DbName": "demo",
    "TableName": "test",
    "IsForce": false
}

Output Example

{
    "Response": {
        "Message": "",
        "RequestId": "41de726a-0bd6-4794-8324-5fd73c312886"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

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