ModifyClusterDesc - 更改集群的描述信息

更改集群的描述信息。

接口说明

方法

PUT

URI

/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:ModifyClusterDesc
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

PUT /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc HTTP/1.1

请求参数

名称类型必填描述示例值
instanceIdstring

实例 ID

ha-cn-pl32rf0****
clusterNamestring

集群名称

sz_vpc_domain_1
bodyobject

请求体参数

{ "description": "自定义描述" }
名称是否必须类型描述
descriptionString集群的描述信息

请求示例

PUT /openapi/ha3/instances/ha3_instance_name/clusters/my_cluster_name/desc

{
  "description":"this is descrition"
}

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID。

D39EE0F1-D7EF-5F46-B781-6BF4185308B0
resultobject

返回结果。

{}

返回示例

{
	"requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": []
}

详情可参考响应结构

示例

正常返回示例

JSON格式

{
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0",
  "result": {}
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI查看变更详情