DescribeConnectableClusters - 获取网络互通实例列表

更新时间:
复制 MD 格式

获取能够与当前实例进行网络互通的实例列表。不包括已经打通的实例。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:DescribeConnectableClusters

get

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}

无 无

请求语法

GET /openapi/instances/{InstanceId}/connectable-clusters HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

InstanceId

string

是

当前实例 ID。

es-cn-n6w1o1x0w001c****

请求参数

名称

类型

必填

描述

示例值

alreadySetItems

boolean

否

是否返回已经互通的实例:

  • true(默认):返回的实例列表中包括已经互通的实例。

  • false:返回的实例列表中不包括已经互通的实例。

true

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

Result

array<object>

返回结果。

object

networkType

string

实例的网络类型。

vpc

instances

string

可以进行网络互通的实例 ID。

es-cn-xxx

示例

正常返回示例

JSON格式

{
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***",
  "Result": [
    {
      "networkType": "vpc",
      "instances": "es-cn-xxx"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 InstanceActivating Instance is activating
400 InstanceNotFound The instanceId provided does not exist

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

变更历史

更多信息,参考变更详情。