delete tidb cluster - DeleteTiDBClusterService
Overview
delete tidb cluster
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is DeleteTiDBClusterService. | Yes |
| PublicKey | string | The user’s public key can be obtained from Console  | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See Region and Zone List | Yes |
| Zone | string | Zone. See Region and Zone List | Yes |
| ProjectId | string | Project ID. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the GetProjectList API | No |
| Id | string | cluster id | Yes |
| DeleteBackup | boolean | delete backup data. True for enabled, False for not enabled, default is False. | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
| ServiceId | string | cluster id | Yes |
Example
Request Example
https://api.ucloud-global.com/?Action=DeleteTiDBClusterService
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=jXMWqlwu
&Id=VLyUWVxI
&DeleteBackup=falseResponse Example
{
"Action": "DeleteTiDBClusterServiceResponse",
"RetCode": 0,
"ServiceId": "UiTXuJaH"
}