Updated on 2026-08-25 GMT+08:00

Obtaining a User Instance

Function

This API is used to obtain a user instance.

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::listInstances

    list

    -

    -

    -

    -

URI

POST /v3/{project_id}/instance/sql-limiting/get-user-instance-list

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. Only letters and digits are supported.

Default Value

N/A

Request Parameters

Table 2 Query parameters

Parameter

Mandatory

Type

Description

engine_type

Yes

String

Definition

DB engine type

Constraints

N/A

Range

N/A

Default Value

N/A

page_num

No

Integer

Definition

Page number

Constraints

N/A

Range

[0, 5000]

Default Value

0

page_size

No

Integer

Definition

Number of records to be queried. If this parameter is set to 10, a maximum of 10 records can be displayed.

Constraints

N/A

Range

[0, 100]

Default Value

20

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

das_instances

Array of Table 4 Objects

Definition

Instance list

Range

Array length: 0 to 200 characters

total

Integer

Definition

Total number

Range

[0,10000]

Table 4 DASInstanceInfo

Parameter

Type

Description

instance_id

String

Definition

Unique ID of an instance

Range

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

instance_name

String

Definition

Instance name

Range

N/A

instance_status

String

Definition

Instance status

Range

N/A

engine_version

String

Definition

Instance version

Range

N/A

engine_type

String

Definition

Engine type

Range

N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instance/sql-limiting/get-user-instance-list 
 
{
    "page_size": 5,
    "page_num": 1,
    "engine_type": "mysql"
}

Example Responses

Status code: 200

Success.

{
    "das_instances": [
        {
            "instance_id": "bcfa975193f1402fa11a6d4fd6baf5fbin01",
            "instance_name": "rds-sql-Do not delete 1.",
            "engine_type": "mysql",
            "engine_version": "5.7",
            "instance_status": "ACTIVE"
        }
    ],
    "total": 1
}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.