Help Center/ EventGrid/ API Reference/ APIs/ Endpoint Management/ Obtaining the Endpoint List
Updated on 2025-05-06 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Endpoint List

Function

This API is used to obtain the list of endpoints.

URI

GET /v1/{project_id}/endpoints

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant resource space ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

Integer

Number of records displayed on each page. The value must be within the range [1, 1000].

sort

No

String

Sorting mode of the query results.

type

No

String

Type of the endpoint.

name

No

String

Name of the endpoint.

vpc_id

No

String

VPC ID of the endpoint.

fuzzy_name

No

String

Name of the endpoint. It is used for fuzzy match.

subnet_id

No

String

Subnet ID for endpoint query.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.
Table 5 Response body parameters

Parameter

Type

Description

total

Integer

Total number of records.

size

Integer

Number of records displayed on the current page.

items

Array of EndpointInfo objects

Object list.
Table 6 EndpointInfo

Parameter

Type

Description

id

String

ID of the endpoint.

name

String

Name of the endpoint.

vpc_id

String

ID of the VPC to which the endpoint belongs.

subnet_id

String

ID of the subnet to which the endpoint belongs.

domain

String

Access domain name.

description

String

Description.

status

String

Status of the endpoint.

error_info

ErrorInfo object

Error message.

type

String

Type of the endpoint.

scalable

Boolean

Whether the endpoint is accessible.

created_time

String

UTC time when the endpoint is created.

updated_time

String

UTC time when the endpoint is updated.

endpoints

Array of EndpointConnection objects

List of endpoints.
Table 7 ErrorInfo

Parameter

Type

Description

error_code

String

Error code.

error_detail

String

Error details.

error_msg

String

Error message.
Table 8 EndpointConnection

Parameter

Type

Description

endpoint_service_id

String

Service ID of the endpoint.

endpoint_service_name

String

Service name of the endpoint.

marker_id

String

Packet ID of the endpoint.

id

String

Node ID of the endpoint.

ip

String

Node IP address of the endpoint.

created_time

String

Time when the endpoint is created.

Example Requests

Obtain the endpoint list.

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

Example Responses

Status code: 200

Operation successful.

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

Status Codes

Status Code

Description

200

Operation successful.

Error Codes

See Error Codes.

Parent topic: Endpoint Management