更新时间:2024-07-30 GMT+08:00

查询服务目录

功能介绍

该接口可以用于查询请求头中X-Auth-Token对应的服务目录。

该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见:地区和终端节点

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/auth/catalog

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

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

X-Auth-Token

String

IAM用户的token。(无需特殊权限,但token的scope需为project。)

响应参数

表2 响应Body参数

参数

参数类型

描述

catalog

Array of objects

服务目录信息列表。

links

Object

资源链接信息。

表3 catalog

参数

参数类型

描述

endpoints

Array of objects

终端节点信息。

id

String

服务ID。

name

String

服务名。

type

String

服务类型。

表4 catalog.endpoints

参数

参数类型

描述

id

String

终端节点ID。

interface

String

终端节点平面,public表示为公开。

region

String

终端节点所属区域。

region_id

String

终端节点所属区域的ID。

url

String

终端节点的地址。

请求示例

查询服务目录。

GET https://iam.myhuaweicloud.com/v3/auth/catalog

响应示例

状态码为 200 时:

请求成功。

{
    "catalog": [
        {
            "endpoints": [
                {
                    "id": "33e1cbdd86d34e89a63cf8ad16a5f49f",
                    "interface": "public",
                    "region": "*",
                    "region_id": "*",
                    "url": "https://iam.myhuaweicloud.com/v3.0"
                }
            ],
            "id": "100a6a3477f1495286579b819d399e36",
            "name": "iam",
            "type": "iam"
        },
        {
            "endpoints": [
                {
                    "id": "6c91faa9890f40b397542561e3d87444",
                    "interface": "public",
                    "region": "*",
                    "region_id": "*",
                    "url": "https://cbc.sample.domain.com/v1.0"
                }
            ],
            "id": "ad7396ee0eea4281a180c4230641b72f",
            "name": "bss-intlv1",
            "type": "bss-intlv1"
        }
    ],
    "links": {
        "self": "https://iam.myhuaweicloud.com/v3/auth/catalog"
    }
}

返回值

返回值

描述

200

请求成功。

400

参数无效。

401

认证失败。

403

没有操作权限。

404

未找到相应的资源。

405

不允许的方法。

413

请求体过大。

501

接口没有实现。

503

服务不可用。

错误码