Updated on 2026-01-20 GMT+08:00

Querying Instance Distribution

Function

This API is used to query instance distribution.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    das::showCloudDBAInfo

    Read

    -

    -

    -

    -

URI

GET /v3/{project_id}/instances/distribution

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters, including only letters and digits.

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

datastore_type

No

String

Definition

Database type

Constraints

N/A

Range

  • MySQL
  • TaurusDB
  • PostgreSQL
  • Microsoft SQL Server

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Definition

Total number

Range

[0, 2^31-1]

engine_distribution

Array of Table 4 objects

Definition

Engine distribution

Range

N/A

Table 4 engine_distribution

Parameter

Type

Description

datastore_type

String

Definition

Database type

Range

N/A

total

Integer

Definition

Total number

Range

[0,2^31-1]

instance_infos

Array of Table 5 objects

Definition

Instance information

Range

N/A

Table 5 engine_distribution.instance_infos

Parameter

Type

Description

status

String

Definition

Instance status

Range

N/A

num

Integer

Definition

Number of instances

Range

[0, 2^31-1]

Example Requests

"GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/distribution?datastore_type=postgresql"

Example Responses

Status code: 200

Successful response

{
  "total": 1,
  "engine_distribution": [
    {
      "datastore_type": "PostgreSQL",
      "total": 1,
      "instance_infos": [
        {
          "status": "OTHERS",
          "num": 1
        },
        {
          "status": "FAILED",
          "num": 0
        },
        {
          "status": "STORAGE_FULL",
          "num": 0
        }
      ]
    }
  ]
}

Status Codes

Status Code

Description

200

Successful response

400

Bad request

500

Internal server error

Error Codes

See Error Codes.