更新时间:2025-04-27 GMT+08:00

查询访问端点

功能介绍

查询访问端点。

URI

GET /v1/{project_id}/endpoints

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户资源空间ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

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

limit

Integer

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

sort

String

指定查询排序

type

String

指定查询访问端点的类型

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的值)。

响应参数

状态码: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

总数

size

Integer

本页数量

items

Array of EndpointInfo objects

对象列表

表6 EndpointInfo

参数

参数类型

描述

id

String

访问端点ID

name

String

用户指定的访问端点名称

vpc_id

String

访问端点所在的VPC的ID

subnet_id

String

访问端点所在的子网的ID

domain

String

访问域名

description

String

描述

status

String

访问端点状态

error_info

ErrorInfo object

错误信息

type

String

访问端点类型

scalable

Boolean

是否可更新

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

endpoints

Array of EndpointConnection objects

访问端点终端节点列表

表7 ErrorInfo

参数

参数类型

描述

error_code

String

错误码

error_detail

String

错误详情

error_msg

String

错误信息

表8 EndpointConnection

参数

参数类型

描述

endpoint_service_id

String

访问端点的服务ID

endpoint_service_name

String

访问端点的服务名称

marker_id

String

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

id

String

访问端点的终端节点ID

ip

String

访问端点的终端节点IP

created_time

String

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

请求示例

查询访问端点

GET https://{eg_endpoint}/v1/{project_id}/endpoints

响应示例

状态码:200

访问端点列表

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

状态码

状态码

描述

200

访问端点列表

错误码

请参见错误码