更新时间:2022-08-16 GMT+08:00

查询终端节点列表

功能介绍

该接口用于查询终端节点列表,提供服务访问入口。

URI

  • URI格式

    GET /v3/endpoints{?interface, service_id}

  • 参数说明

    参数

    是否必选

    类型

    说明

    interface

    String

    终端节点平面。

    可能取值为:public,internal或admin。

    • public: 用户可在公共网络接口上看到。
    • internal:用户可在内部网络接口上看到。
    • admin:管理员可以在安全的网络接口上看到。

    service_id

    String

    服务ID。

请求

  • Request Header参数说明

    参数

    是否必选

    类型

    说明

    Content-Type

    String

    该字段内容填为“application/json;charset=utf8”

    X-Auth-Token

    String

    已认证的token。

  • 请求样例
    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/endpoints?interface=public&service_id=43cbe5e77aaf4665bbb962062dc1fc9d

响应

  • Response Body参数说明

    参数

    是否必选

    类型

    说明

    links

    dict

    终端节点的资源链接。

    endpoints

    list

    终端节点列表。

  • endpoints格式说明

    参数

    是否必选

    类型

    说明

    id

    String

    终端节点ID。

    url

    String

    终端节点的地址。

    region

    String

    终端节点的区域。

    region_id

    String

    终端节点的区域ID。

    enabled

    Boolean

    终端节点是否可用。

    interface

    String

    终端节点的平面。

    service_id

    String

    终端节点所属服务的ID。

    links

    dict

    终端节点的资源链接。

  • 响应样例(请求成功)
    {
        "endpoints": [
            {
                "region_id": null,
                "links": {
                    "self": "https://sample.domain.com/v3/endpoints/162277d696f54cf592f19b569f85d158"
                },
                "url": "https://sample.domain.com/v3",
                "region": null,
                "enabled": true,
                "interface": "public",
                "service_id": "053d21d488d1463c818132d9d08fb617",
                "id": "162277d696f54cf592f19b569f85d158"
            }
        ],
        "links": {
            "self": "https://sample.domain.com/v3/endpoints?service_id=053d21d488d1463c818132d9d08fb617&interface=public",
            "previous": null,
            "next": null
        }
    }

状态码

状态码

说明

200

请求成功。

400

请求错误。

401

认证失败。

403

鉴权失败。

404

找不到资源。

405

不允许的方法。

413

请求体过大。

500

内部服务错误。

503

服务不可用。