Updated on 2024-07-30 GMT+08:00

Listing Services

Function

This API is used to list all services.

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/services

Table 1 Query parameters

Parameter

Mandatory

Type

Description

type

No

String

Service type.

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

links

Object

Service resource link information.

services

Array of objects

Service information.

Table 5 services

Parameter

Type

Description

name

String

Service name.

description

String

Description of the service.

links

Object

Service resource link.

id

String

Service ID.

type

String

Service type.

enabled

Boolean

Enabling status of the service.

Example Request

Request for querying a list of services

GET https://iam.myhuaweicloud.com/v3/services

Example Response

Status code: 200

The request is successful.

{
    "links": {
        "next": null,
        "previous": null,
        "self": "https://iam.myhuaweicloud.com/v3/services"
    },
    "services": [
        {
            "name": "keystone",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.com/v3/services/1842ae22353d45a39a1eb89c22f0fe50"
            },
            "id": "1842ae22353d45a39a1eb89c22f0fe50",
            "type": "identity",
            "enabled": true
        },
        {
            "name": "iam",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.com/v3/services/6cf6e23e00dd49beb13313b024aec598"
            },
            "id": "6cf6e23e00dd49beb13313b024aec598",
            "type": "identity",
            "enabled": true
        }
    ]
}

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.

Error Codes

None