更新集群描述信息
接口URL
/api/v1/cluster/tidbs/{clusterID}
请求方式
PUT
Content-Type
application/json
认证方式
Bearer auth
路径变量
参数名 | 示例值 | 参数描述 |
---|---|---|
clusterID | tidb-43bd353978db0af4 | 操作的集群ID |
请求Body参数
{
"Labels": [
"test",
"user"
],
"Creator": "liusx",
"Alias": "a test cluster",
"Description": "the tidb"
}
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
Labels | test | Array | 是 | 自定义标签 |
Creator | liusx | String | 是 | - |
Alias | a test cluster | String | 是 | 集群别名,可自定义,可重复 |
Description | the tidb | String | 是 | - |
成功响应示例
{
"Data": null,
"Success": true
}
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
Data | null | Null | |
Success | true | Boolean |