调用ListClusterNames获取集群可选择的名称_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

获取集群可选择的名称。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/cluster-names

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

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

请求语法

GET /openapi/ha3/cluster-names HTTP/1.1

请求参数

名称	类型	必填	描述	示例值

当前API无需请求参数

请求示例

GET /openapi/ha3/instances/ha3_instance_name/cluster-names

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID。	F6E3D968-529C-5C40-AFDD-133A8B8FD930
result	object	返回结果。
name	string	集群名称。	hz_pre_vpc_domain_1
description	string	集群描述。	自定义描述
id	long	集群 ID。	25030

返回示例

正确返回

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": [
    {
      "name":"pre",
      "description":"pre 机房",
      "id": 1,
    }
  ]
}

示例

正常返回示例

JSON格式

{
  "requestId": "F6E3D968-529C-5C40-AFDD-133A8B8FD930",
  "result": {
    "name": "hz_pre_vpc_domain_1",
    "description": "自定义描述",
    "id": 25030
  }
}

错误码

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

变更历史

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

示例

请求示例

GET /openapi/ha3/instances/ha3_instance_name/cluster-names

###返回示例正确返回

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": [
    {
      "name":"pre",
      "description":"pre 机房",
      "id": 1,
    }
  ]
}