ModifyClusterDesc_开放搜索-问天引擎_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

方法

PUT

URI

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
searchengine:ModifyClusterDesc
Write
Instance
acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

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

路径参数

字段名称字段详情
instanceIdstring

实例 ID

示例值:ha-cn-pl32rf0****参考取值来源:
    ListInstances
    UpdateInstance
    CreateInstance
    CloneSqlInstance
    ExecuteSqlInstance
clusterNamestring

集群名称

示例值:sz_vpc_domain_1参考取值来源:
    GetCluster
    ListClusters

请求参数

字段名称字段详情
bodyobject

请求体参数

示例值:{ "description": "自定义描述" }

请求说明

| 名称 | 是否必须 | 类型 | 描述 |

| ----------- | -------- | ------ | -------------- | | description | 是 | String | 集群的描述信息 |

请求示例

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

{
  "description":"this is descrition"
}

返回参数

字段名称字段详情
requestIdstring

请求 ID。

示例值:D39EE0F1-D7EF-5F46-B781-6BF4185308B0
resultobject

返回结果。

示例值:{}

返回说明

返回示例

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

详情可参考响应结构

返回示例

变更历史

变更时间变更内容概要操作
2022-09-05
变更请求参数instanceId
变更请求参数clusterName
变更返回参数
2022-01-12
新增OpenAPI,更改集群的描述信息

相关示例