Querying All Instance Types

Function

This API is used to query all instance types.

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

connection

-

das:connections:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
das::listInstances	list	connection	-	das:connections:list	-

URI

GET /v3/{project_id}/all-type-instances

**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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
name	No	String	Definition Instance name Constraints N/A Range N/A Default Value N/A
cur_page	No	Integer	Definition Page number Constraints N/A Range [0, 2^31 – 1]. The actual value depends on the query result. Default Value N/A
per_page	No	Integer	Definition Number of records on each page Constraints N/A Range [0, 100]. The actual value depends on the query result. Default Value N/A
network_type	No	String	Definition Source database type Constraints N/A Range rds gaussdb dds ddm Default Value N/A
engine_type	No	String	Definition DB engine type Constraints N/A Range mysql sqlserver postgresql taurus gaussdbv5 mongodb ddm Default Value N/A
id	No	String	Definition Unique ID of an instance Constraints N/A Range The value can contain 32 characters. Only letters and digits are supported. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_count	Integer	Definition Total number of records Range N/A
instances	Array of Table 4 objects	Definition Instance information list Range N/A

**Table 4** DasCommonInstanceDto
Parameter	Type	Description
name	String	Definition Instance name Range N/A
id	String	Definition Instance ID Range The value can contain 32 characters. Only letters and digits are supported.
status	String	Definition Instance status Range N/A
type	String	Definition Instance type Range N/A
enterprise_project_id	String	Definition Enterprise project ID Range N/A
engine_type	String	Definition DB engine type Range mysql sqlserver postgresql taurus gaussdbv5 mongodb ddm
engine_version	String	Definition Instance engine version Range N/A
port	String	Definition Instance engine port Range N/A
region	String	Definition Region Range N/A
nodes	Array of Table 5 objects	Definition Instance node list Range N/A
network_type	String	Definition Source database type Constraints N/A Range rds gaussdb dds ddm Default Value N/A
related_instance	Array of Table 6 objects	Definition List of related instances Range N/A

**Table 5** DasCommonInstanceNodeDto
Parameter	Type	Description
id	String	Definition Node ID Range The value can contain 32 characters. Only letters and digits are supported.
name	String	Definition Node name Range N/A
status	String	Definition Node status Range N/A
role	String	Definition Node role Range N/A
private_ip	String	Definition Node private IP address Range N/A
public_ip	String	Definition Node public IP address Range N/A
group_id	String	Definition Node group ID Range N/A
group_name	String	Definition Node group name Range N/A

**Table 6** RelatedInstance
Parameter	Type	Description
id	String	Definition Instance ID Range The value can contain 32 characters. Only letters and digits are supported.
type	String	Definition Instance type Range N/A
name	String	Definition Instance name Range N/A

Example Requests

GET https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/all-type-instances?per_page=5&cur_page=1&name=&network_type=rds&engine_type=mysql

Example Responses

Status code: 200

Success.

{
    "instances": [
        {
            "id": "14f3ae83797947f2b9669e645202a757in01",
            "name": "rds-7be6",
            "status": "ACTIVE",
            "type": "Single",
            "enterprise_project_id": "2d92cf15-8698-4ade-ad00-b206b5256c36",
            "engine_type": "mysql",
            "engine_version": "5.7",
            "port": "3306",
            "region": "cn-south-4",
            "network_type": "rds",
            "related_instance": []
        }
    ],
    "total_count": 1
}

Status Codes

Status Code	Description
200	Success.
400	Client error.
500	Server error.

Error Codes

See Error Codes.

Parent topic: Development Tool

Previous topic: Querying the Instance Connection List

Next topic: APIs (Deprecated)