文档首页/API网关 APIG/API参考/专享版API（V2）/专享版-实例终端节点管理/查询实例终端节点连接列表 - ListEndpointConnections
更新时间：2025-12-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例终端节点连接列表 - ListEndpointConnections

功能介绍

查询实例终端节点连接列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    apig:instance:listVpcEndpoint

    List

    instance *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    apig:instance:get

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/connections

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0

缺省值：0

limit

否

Integer

每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500

最小值：1

最大值：500

缺省值：20

id

否

String

终端节点的ID，唯一标识

marker_id

否

Integer

终端节点的报文标识

status

否

String

终端节点的连接状态

  • pendingAcceptance 待接受

  • accepted 已接受

  • rejected 已拒绝

  • failed 失败

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号

表5 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

connections

Array of EndpointConnection objects

连接列表

表6 EndpointConnection

参数

参数类型

描述

id

String

连接编号

marker_id

Integer

连接报文标识

created_at

String

连接创建时间。UTC时间，格式：YYYY-MM-DDTHH:MM:SSZ

updated_at

String

连接更新时间。UTC时间，格式：YYYY-MM-DDTHH:MM:SSZ

domain_id

String

用户的Domain ID

status

String

连接状态

  • pendingAcceptance 待接受

  • creating 创建中

  • accepted 已接受

  • rejected 已拒绝

  • failed 失败

  • deleting 删除中

状态码：401

表7 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表9 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：404

表11 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表13 响应Header参数

参数

参数类型

描述

x-request-id

String

请求编号

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

OK

{
  "total" : 2,
  "size" : 1,
  "connections" : [ {
    "id" : "76ad893c-6a1e-4055-8019-fe9c9bd3204d",
    "marker_id" : 167960098,
    "created_at" : "2021-04-29T02:12:44Z",
    "updated_at" : "2021-04-29T02:12:45Z",
    "domain_id" : "b70fde8e849b4e76a61dd8aa0ec05c81",
    "status" : "accepted"
  } ]
}

状态码：401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

状态码：404

Resource Not Found

{
  "error_code" : "APIC.7314",
  "error_msg" : "Endpoint service not found"
}

状态码：500

Internal Server Error

{
  "error_code" : "APIC.9007",
  "error_msg" : "Failed to execute VPCEP request"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Resource Not Found

500

Internal Server Error

错误码

请参见错误码。