ListVpcEndpoints - ListVpcEndpoints-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

调用ListVpcEndpoints，查看服务账号VPC下的终端节点状态。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:ListVpcEndpoints

get

*Instance

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

无

请求语法

GET /openapi/instances/{InstanceId}/vpc-endpoints HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	es-cn-2r429tctl000d****

请求参数

名称	类型	必填	描述	示例值
size	integer	否	分页查询时设置的每页条数。默认值：20。	10
page	integer	否	列表的页码。起始值：1，默认值：1。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	F99407AB-2FA9-489E-A259-40CF6DCC47D9
Result	array<object>	终端节点信息详情。
	object
endpointBusinessStatus	string	终端节点的业务状态，取值含义如下： Normal：正常。 FinancialLocked：欠费锁定。	Normal
serviceId	string	终端节点关联的终端节点服务的 ID。	epsrv-bp1w0p3jdirbfmt6****
endpointName	string	终端节点名称。	test
endpointId	string	终端节点 ID。	ep-bp1tah7zbrwmkjef****
serviceName	string	终端节点关联的终端节点服务的名称。	com.aliyuncs.privatelink.cn-hangzhou.epsrv-bp1w0p3jdirbfmt6****
createTime	string	终端节点的创建时间，采用 ISO 8601 格式，以 UTC 时间表示。	2021-07-22T01:19:24Z
connectionStatus	string	终端节点连接状态，取值含义如下： Pending：修改中。 Connecting：连接中。 Connected：已连接。 Disconnecting：断开连接中。 Disconnected：未连接。 Deleting：删除中。 ServiceDeleted：终端节点对应的服务已删除。	Disconnected
endpointDomain	string	终端节点域名，用于连接配置。	ep-bp18s6wy9420wdi4**.epsrv-bp1bz3efowa4kc0**.cn-hangzhou.privatelink.aliyuncs.com
endpointStatus	string	终端节点状态，取值含义如下： Creating：创建中。 Active：可用。 Pending：修改中。 Deleting：删除中。	Active

示例

正常返回示例

JSON格式

{
  "RequestId": "F99407AB-2FA9-489E-A259-40CF6DCC47D9",
  "Result": [
    {
      "endpointBusinessStatus": "Normal",
      "serviceId": "epsrv-bp1w0p3jdirbfmt6****",
      "endpointName": "test",
      "endpointId": "ep-bp1tah7zbrwmkjef****",
      "serviceName": "com.aliyuncs.privatelink.cn-hangzhou.epsrv-bp1w0p3jdirbfmt6****",
      "createTime": "2021-07-22T01:19:24Z",
      "connectionStatus": "Disconnected",
      "endpointDomain": "ep-bp18s6wy9420wdi4****.epsrv-bp1bz3efowa4kc0****.cn-hangzhou.privatelink.aliyuncs.com",
      "endpointStatus": "Active"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
400	ComponentCodeValueError	component value is disable
401	UserNotOpen	Aliyun account is not open elasticsearch
401	StsRoleAccountNoPermission	Role account has no permission or expired
401	SubAccountNoPermission	Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM
401	UserUnauthorized	Authentication required

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

变更历史

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