文档首页> 事件网格 EG> API参考> API> 访问端点管理> 查询访问端点
更新时间：2023-12-12 GMT+08:00
查看PDF
分享

查询访问端点

功能介绍

查询访问端点。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/endpoints

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询，偏移量不能小于0

最小值：0

最大值：100

缺省值：0

limit

否

Integer

每页显示的条目数量，不能小于1或大于1000

最小值：1

最大值：1000

缺省值：15

sort

否

String

指定查询排序

缺省值：created_time:DESC

type

否

String

指定查询访问端点的类型

枚举值：

  • PRIVATE

  • PUBLIC

name

否

String

指定查询访问端点的名称

vpc_id

否

String

指定查询访问端点的vpcId

fuzzy_name

否

String

指定查询访问端点的名称,模糊查询

subnet_id

否

String

指定查询访问端点的SubnetId

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：16384

响应参数

状态码： 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.
表5 响应Body参数

参数

参数类型

描述

total

Integer

总数

最小值：0

最大值：100

size

Integer

本页数量

最小值：0

最大值：100

items

Array of EndpointInfo objects

对象列表

数组长度：0 - 100
表6 EndpointInfo

参数

参数类型

描述

id

String

访问端点ID

name

String

用户指定的访问端点名称

vpc_id

String

访问端点所在的VPC的ID

subnet_id

String

访问端点所在的子网的ID

domain

String

访问域名

description

String

描述

status

String

访问端点状态

枚举值：

  • CREATED

  • CREATING

  • CREATE_FAILED

  • DELETE_FAILED

error_info

ErrorInfo object

type

String

访问端点类型

枚举值：

  • PRIVATE

  • PUBLIC

scalable

Boolean

是否可更新

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

endpoints

Array of EndpointConnection objects

访问端点终端节点列表
表7 ErrorInfo

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_detail

String

错误详情

最小长度：1

最大长度：128

error_msg

String

错误信息

最小长度：1

最大长度：128
表8 EndpointConnection

参数

参数类型

描述

endpoint_service_id

String

访问端点的服务ID

endpoint_service_name

String

访问端点的服务名称

marker_id

String

访问端点的终端节点的报文ID

id

String

访问端点的终端节点ID

ip

String

访问端点的终端节点IP

created_time

String

访问端点的终端节点创建时间

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：512

error_details

String

具体错误消息

最小长度：1

最大长度：1024

request_id

String

请求处理ID

最小长度：1

最大长度：128

状态码： 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：512

error_details

String

具体错误消息

最小长度：1

最大长度：1024

request_id

String

请求处理ID

最小长度：1

最大长度：128

状态码： 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：512

error_details

String

具体错误消息

最小长度：1

最大长度：1024

request_id

String

请求处理ID

最小长度：1

最大长度：128

状态码： 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：512

error_details

String

具体错误消息

最小长度：1

最大长度：1024

request_id

String

请求处理ID

最小长度：1

最大长度：128

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：512

error_details

String

具体错误消息

最小长度：1

最大长度：1024

request_id

String

请求处理ID

最小长度：1

最大长度：128

请求示例

无

响应示例

状态码： 400

{
  "error_code" : "EG.00014000",
  "error_msg" : "Bad request"
}

状态码： 401

{
  "error_code" : "EG.00014010",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

{
  "error_code" : "EG.00014030",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

{
  "error_code" : "EG.00014040",
  "error_msg" : "Not request resource found"
}

状态码： 500

{
  "error_code" : "EG.00015000",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

访问端点列表

400

非法请求

401

未授权

403

禁止访问

404

未找到资源

500

内部服务错误

错误码

请参见错误码。

父主题： 访问端点管理
分享：

    相关文档

    相关产品