Updated on 2025-11-24 GMT+08:00

Querying Instance Distribution

Function

This API is used to query instance distribution.

URI

GET /v3/{project_id}/instances/distribution

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

Table 2 Query parameter

Parameter

Mandatory

Type

Description

datastore_type

No

String

Explanation:

Database type

Constraints:

N/A

Values:

  • 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

Explanation:

Total number

Values:

[0, 2^31-1]

engine_distribution

Array of Table 4 objects

Explanation:

Engine distribution

Values:

N/A

Table 4 engine_distribution

Parameter

Type

Description

datastore_type

String

Explanation:

Database type

Values:

N/A

total

Integer

Explanation:

Total number

Values:

[0,2^31-1]

instance_infos

Array of Table 5 objects

Explanation:

Instance information

Values:

N/A

Table 5 engine_distribution.instance_infos

Parameter

Type

Description

status

String

Explanation:

Instance status

Values:

N/A

num

Integer

Explanation:

Number of instances

Values:

[0, 2^31-1]

Example Request

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

Example Response

Status code: 200

Successful request

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

400

Bad request

500

Internal server error

Error Codes

See Error Codes.