Querying a List of Endpoints

Function

This API is used to obtain details about all endpoints.

If no query parameter is specified, information about all endpoints under the account and all shared endpoints in the system is returned.

If more than one query parameter is specified, information about the endpoints that meet all the specified parameters is returned.

URI

GET /v2/{project_id}/routemgr/endpoints?{name=xxx,limit=xxx,offset=xxx}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
name	No	String	Endpoint name.
type	No	String	Endpoint type. The options are as follows: dis servicebus apigw
is_shared	No	Boolean	Whether the endpoint is shared.
limit	No	Integer	Maximum number of records that can be returned.
offset	No	Integer	Offset. The records after this offset will be queried.

Request

**Table 3** Parameters in the request header
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). The default value application/json is recommended.
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

When the status code is 200, the response parameters are as follows.

**Table 4** Parameters in the response body
Parameter	Type	Description
count	Long	Number of endpoints that meet the conditions.
endpoints	Array of EndpointResponse objects	Endpoint list.

**Table 5** EndpointResponse
Parameter	Type	Description
created_at	String	Creation time.
description	String	Endpoint description. The value contains a maximum of 255 characters. The following characters are not allowed: ^~#$%&*<>()[]{}'"\
id	String	Endpoint ID.
ief_instance_id	String	Platinum edition instance ID. This parameter is left blank for a professional edition instance.
is_shared	Boolean	Whether the endpoint is shared.
name	String	Endpoint name. The value contains a maximum of 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. The endpoint name must be unique in the account.
project_id	String	Project ID.
properties	Map<String,Object>	Endpoint properties to be displayed. Example: dis: {"domain_id":"user's domain id"} servicebus: {"service_port":8080} apigw: {"domain_id":"user's domain id"}
type	String	Endpoint type. The options are as follows: dis servicebus apigw
updated_at	String	Update time.

When the status code is 401, the response parameters are as follows.

**Table 6** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_message	String	Error message.

When the status code is 500, the response parameters are as follows:

**Table 7** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code.
error_message	String	Error message.

Example Request

None

Example Response

None

Status Code

Status Code	Description
200	Query succeeded.
401	Error response.
500	Error response.

Error Codes

For details, see Error Codes.

Parent topic: Endpoint Management

Previous topic: Endpoint Management

Next topic: Creating an Endpoint

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot