更改集群的描述信息。
接口说明
方法
PUT
URI
/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc
。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
PUT /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
instanceId | string | 是 | 实例ID | ha-cn-c4d2rq7nt04 |
clusterName | string | 是 | 集群名称 | sz_vpc_domain_1 |
body | object | 否 | 请求体参数 | {} |
名称 | 是否必须 | 类型 | 描述 |
---|---|---|---|
description | 是 | String | 集群的描述信息 |
请求示例
PUT /openapi/ha3/instances/ha3_instance_name/clusters/my_cluster_name/desc
{
"description":"this is descrition"
}
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0",
"result": {
"test": "test",
"test2": 1
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-01-12 | 新增 OpenAPI |