Listing Endpoints

Updated on 2023-09-14 GMT+08:00

View PDF

Function

This API is used to list all endpoints. An endpoint provides an entry to a specific service.

The API can be called using both the global endpoint and region-specific endpoints.

URI

GET /v3/endpoints

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
interface	No	String	Plane to which the endpoint belongs.
service_id	No	String	Service ID.

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
X-Auth-Token	Yes	String	IAM user token (no special permission requirements).

Response Parameters

**Table 3** Parameters in the response body
Parameter	Type	Description
endpoints	Array of objects	Resource link.
links	Object	Endpoint information.

**Table 4** endpoints
Parameter	Type	Description
service_id	String	ID of the service to which the endpoint belongs.
region_id	String	ID of the region to which the endpoint belongs.
links	Object	Endpoint resource link information.
id	String	Endpoint ID.
interface	String	Plane to which the endpoint belongs.
region	String	Region to which the endpoint belongs.
url	String	Endpoint URL.
enabled	Boolean	Enabling status of the endpoint.

**Table 5** endpoints.links
Parameter	Type	Description
self	String	Resource link.
next	String	Next resource link.
previous	String	Previous resource link.

**Table 6** links
Parameter	Type	Description
self	String	Resource link.
previous	String	Previous resource link.
next	String	Next resource link.

Example Request

Request for querying endpoints

GET https://iam.myhuaweicloud.eu/v3/endpoints

Example Response

Status code: 200

The request is successful.

{
    "endpoints": [
        {
            "service_id": "3e93d3eb20b34bfbbdcc81a79c1c3045",
            "region_id": "eu-west-101",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.eu/v3/endpoints/0046cca357c94165b7a10ec2c01bdf60"
            },
            "id": "0046cca357c94165b7a10ec2c01bdf60",
            "interface": "public",
            "region": "eu-west-101",
            "url": "https://ims.sample.domain.com",
            "enabled": true
        },
        {
            "service_id": "5186586acd38461d84b3dbf9f02e33ae",
            "region_id": "eu-west-101",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.eu/v3/endpoints/00d546d4823e452491407284ab26612c"
            },
            "id": "00d546d4823e452491407284ab26612c",
            "interface": "public",
            "region": "eu-west-101",
            "url": "https://ges.sample.domain.com/v1.0/$(tenant_id)s",
            "enabled": true
        }
    ],
    "links": {
        "next": null,
        "previous": null,
        "self": "https://iam.myhuaweicloud.eu/v3/endpoints"
    }
}

Status Codes

Status Code	Description
200	The request is successful.
400	Invalid parameters.
401	Authentication failed.
403	Access denied.
404	The requested resource cannot be found.
405	The method specified in the request is not allowed for the requested resource.
413	The request entity is too large.
501	The API is not available.
503	Service unavailable.