Querying the Service Catalog

Function

This API is used to query the service catalog corresponding to X-Auth-Token contained in the request.

The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/auth/catalog

Request Parameters

**Table 1** 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 permissions are required, but the scope of the token must be project.)

Response Parameters

**Table 2** Parameters in the response body
Parameter	Type	Description
catalog	Array of objects	Service catalog information.
links	Object	Resource link information.

**Table 3** catalog
Parameter	Type	Description
endpoints	Array of objects	Endpoint information.
id	String	Service ID.
name	String	Service name.
type	String	Service type.

**Table 4** catalog.endpoints
Parameter	Type	Description
id	String	Endpoint ID.
interface	String	Plane which the endpoint belongs to. The value is public.
region	String	Region which the endpoint belongs to.
region_id	String	ID of the region which the endpoint belongs to.
url	String	Endpoint URL.

**Table 5** links
Parameter	Type	Description
self	String	Resource link.

Example Request

Request for querying a service catalog

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

Example Response

Status code: 200

The request is successful.

{
    "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"
    }
}

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.