Skip to Content
Distributed NewSQL Database(TiDB)DeleteTiDBClusterService

delete tidb cluster - DeleteTiDBClusterService

Overview

delete tidb cluster

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DeleteTiDBClusterService.Yes
PublicKeystringThe user’s public key can be obtained from Console Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See Region and Zone ListYes
ZonestringZone. See Region and Zone ListYes
ProjectIdstringProject ID. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the GetProjectList APINo
Idstringcluster idYes
DeleteBackupbooleandelete backup data. True for enabled, False for not enabled, default is False.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
ServiceIdstringcluster idYes

Example

Request Example

https://api.ucloud-global.com/?Action=DeleteTiDBClusterService &Region=cn-zj &Zone=cn-zj-01 &ProjectId=jXMWqlwu &Id=VLyUWVxI &DeleteBackup=false

Response Example

{ "Action": "DeleteTiDBClusterServiceResponse", "RetCode": 0, "ServiceId": "UiTXuJaH" }