Queries the details of a cluster.
Operation description
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request syntax
GET /openapi/ha3/instances/{instanceId}/clusters/{clusterName}
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
instanceId | string | Yes | The instance ID. | ha-cn-0ju2rq6610a |
clusterName | string | No | The name of the cluster | bj_vpc_domain_2 |
Response parameters
Sample responses
{
"requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
"result": {
"name": "cluster1",
"configUpdateTime": "2021-08-09 00:01:02",
"CurrentAdvanceConfigVersion": "test_yyds_data1",
"lastestAdvanceConfigVersion": "test_yyds_data1",
"currentOnlineConfigVersion": "test_yyds_data1",
"lastestOnlineConfigVersion": "test_yyds_data1",
"description": "airecpre",
"queryNode": {
"name":"ha-cn-0ju2iimcu07_qrs",
"number": 1
},
"dataNode": {
"name":"general",
"number": 2,
"partition": 1
}
}
}
Examples
Sample success responses
JSON
format
{
"requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
"result": {
"name": "general",
"description": "fzz_test",
"currentAdvanceConfigVersion": "test_yyds_data1",
"latestAdvanceConfigVersion": "test_yyds_data1",
"currentOnlineConfigVersion": "test_yyds_data1",
"latestOnlineConfigVersion": "test_yyds_data1",
"configUpdateTime": "2021-08-09 00:01:02",
"status": "NEW",
"queryNode": {
"name": "test",
"number": 1,
"partition": 2
},
"dataNode": {
"name": "test",
"number": 1,
"partition": 2
},
"createTime": "2024-05-21 16:05:26",
"config": {
"key": {
"key": {
"name": "ha-cn-pl32rf0****_offline_adv_v1\n",
"updateTime": "2024-05-21 16:05:26",
"desc": "Custom description\n"
}
}
}
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-05-16 | The response structure of the API has changed | View Change Details |
2022-01-12 | Add Operation | View Change Details |