get tidb cluster service - GetTiDBClusterService
Overview
get tidb cluster service
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is GetTiDBClusterService. | 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 | No |
| 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 | service id | Yes |
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 |
| Data | UTiDBServiceData | cluster info | Yes |
Data Model
UTiDBServiceData
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| GrafanaUrl | string | grafana url | No |
| Id | string | cluster id | No |
| Name | string | cluster name | No |
| Ip | string | cluster ip | No |
| Port | int | cluster port | No |
| State | string | cluster state | No |
| TiFlashState | string | cluster TiFlash state | No |
| BinlogState | string | cluster Binlog state | No |
| AutoBackup | string | cluster auto backup state | No |
| VPCId | string | VPC ID | No |
| SubnetId | string | subnet id | No |
| Version | string | cluster version | No |
| DTType | int | dt type | No |
| DashboardUrl | string | dashboard url | No |
| CreateTime | int | create time | No |
Example
Request Example
https://api.ucloud-global.com/?Action=GetTiDBClusterService
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=VDWpekbh
&Id=KtUkbOjgResponse Example
{
"Action": "GetTiDBClusterServiceResponse",
"Data": {},
"RetCode": 0
}