• Identity and Access Management

iam
  1. Help Center
  2. Identity and Access Management
  3. API Reference
  4. Services and Endpoints
  5. Querying Endpoints

Querying Endpoints

Function Description

This interface is used to query the list of terminal addresses and provides a service access entry.

URI

  • URI format

    GET /v3/endpoints{?interface, service_id}

  • URI parameter description

    Parameter

    Mandatory

    Type

    Description

    interface

    No

    String

    Plane to which an endpoint belongs.

    The value can be public, internal, or admin.

    • public: Users can view it on the public network interface.
    • internal: Users can view it on the internal network interface.
    • admin: The administrator can view it on the secure network interface.

    service_id

    No

    String

    Service ID.

Request

  • Request header parameter description

    Parameter

    Mandatory

    Type

    Description

    Content-Type

    Yes

    String

    Fill application/json;charset=utf8 in this field.

    X-Auth-Token

    Yes

    String

    Authenticated token.

  • Sample request
    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://172.30.48.86:31943/v3/endpoints?interface=public&service_id=43cbe5e77aaf4665bbb962062dc1fc9d

Response

  • Response body parameter description

    Parameter

    Mandatory

    Type

    Description

    links

    Yes

    dict

    Resource links of endpoints.

    endpoints

    Yes

    list

    List of endpoints.

  • Description for the endpoints format

    Parameter

    Mandatory

    Type

    Description

    id

    Yes

    String

    Endpoint ID.

    url

    Yes

    String

    Terminal endpoint URL.

    region

    Yes

    String

    Region to which an endpoint belongs.

    region_id

    Yes

    String

    ID of the region to which an endpoint belongs.

    enabled

    Yes

    Boolean

    Whether an endpoint is available.

    interface

    Yes

    String

    Plane to which an endpoint belongs.

    service_id

    Yes

    String

    ID of the service to which an endpoint belongs.

    links

    Yes

    dict

    Resource links of endpoints.

  • Sample response (successful request)
    {
        "endpoints": [
            {
                "region_id": null,
                "links": {
                    "self": "https://iamcore_links.com/v3/endpoints/162277d696f54cf592f19b569f85d158"
                },
                "url": "https://10.185.190.104:7443/v3",
                "region": null,
                "enabled": true,
                "interface": "public",
                "service_id": "053d21d488d1463c818132d9d08fb617",
                "id": "162277d696f54cf592f19b569f85d158"
            }
        ],
        "links": {
            "self": "https://iamcore_links.com/v3/endpoints?service_id=053d21d488d1463c818132d9d08fb617&interface=public",
            "previous": null,
            "next": null
        }
    }

Status Codes

Status Code

Description

200

The request is successful.

400

The server failed to process the request.

401

You must enter a username and password to access the requested page.

403

You are forbidden to access the requested page.

404

The server could not find the requested page.

405

You are not allowed to use the method specified in the request.

413

The request entity is too large.

500

Failed to complete the request because of an internal service error.

503

Failed to complete the request because the service is unavailable.