ListEndpoints - 获取终端节点列表

调用ListEndpoints接口,获取在ES Serverless平台创建的VPC终端节点列表。

调试

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

授权信息

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

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

请求语法

GET /openapi/es-serverless/endpoints

请求参数

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

节点类型, 默认 VPC。

VPC
pageNumberinteger

页码,默认值:1。

1
pageSizeinteger

每页记录数,默认值:10。

10
vpcIdstring

VPC 网络 ID。

vpc-bp1212sb7cj2j4e6x****
resourceIdstring

资源 ID,VPC 类型资源 ID 对应为 privatelink 实例 ID。

ep-bp1id41dd116e52e****

返回参数

名称类型描述示例值
object

响应体结构。

requestIdstring

请求 ID。

D6030CE6-9FEB-5B2F-84AC-3ADE3CBA89E5
resultarray<object>

返回结果。

object

返回结果。

endpointIdstring

端点 ID。

essep-2f46b743f60****
resourceIdstring

资源 ID,VPC 类型资源 ID 对应为 PrivateLink 实例 ID。

ep-bp1id41dd116e52e****
vpcIdstring

VPC 网络 ID。

vpc-uf6gykvwcirp886ef****
statusstring

终端节点状态:

  • Creating:创建中。
  • Active:可用。
  • Pending:修改中。
  • Deleting:删除中。
Active
connectionStatusstring

终端节点连接状态:

  • Pending:修改中。
  • Connecting:连接中。
  • Connected:已连接。
  • Disconnecting:断开连接中。
  • Disconnected:未连接。
  • Deleting:删除中。
  • ServiceDeleted:终端节点对应的服务已删除。
Pending
typestring

节点类型, 默认 VPC。

VPC
createdinteger

创建时间戳(秒级时间戳)。

1701259721
updatedinteger

更新时间戳(秒级时间戳)。

1701259721
namestring

终端节点名称。

test
endpointZonesarray<object>

可用区信息列表。

object

可用区信息。

zoneIdstring

可用区 ID。

cn-hangzhou-k
vSwitchIdstring

虚拟专有交换机,其所在可用区必须与 Serverless 应用一致。

vsw-bp194pz9iez****
securityGroupIdsarray

安全组 ID 列表。

string

安全组 ID。

sg-bp1278950t9ykn2s****
domainstring

终端节点域名。

ep-bp1i522d****a3.epsrv-bp1f****gei.cn-hangzhou.privatelink.aliyuncs.com
totalCountinteger

记录总数。

10

示例

正常返回示例

JSON格式

{
  "requestId": "D6030CE6-9FEB-5B2F-84AC-3ADE3CBA89E5",
  "result": [
    {
      "endpointId": "essep-2f46b743f60****",
      "resourceId": "ep-bp1id41dd116e52e****\n",
      "vpcId": "vpc-uf6gykvwcirp886ef****",
      "status": "Active",
      "connectionStatus": "Pending",
      "type": "VPC",
      "created": 1701259721,
      "updated": 1701259721,
      "name": "test",
      "endpointZones": [
        {
          "zoneId": "cn-hangzhou-k",
          "vSwitchId": "vsw-bp194pz9iez****"
        }
      ],
      "securityGroupIds": [
        "sg-bp1278950t9ykn2s****"
      ],
      "domain": "ep-bp1i522d****a3.epsrv-bp1f****gei.cn-hangzhou.privatelink.aliyuncs.com"
    }
  ],
  "totalCount": 10
}

错误码

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