Viewing the Instance List on the Intelligent O&M Page

Function

This API is used to view the instance list on the Intelligent O&M page.

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

-

-

das:connections:list

-

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

URI

GET /v3/{project_id}/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
datastore_type	Yes	String	Definition Database type Constraints N/A Range mysql: RDS for MySQL sqlserver: RDS for SQL Server postgresql: RDS for PostgreSQL mariadb: RDS for MariaDB mysql-turbo: RDS for TaurusDB taurus: TaurusDB gaussdbv5: GaussDB mongodb: DDS ddm: Distributed Database Middleware (DDM) Default Value N/A
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. If this parameter is set to 1 and limit is set to 10, only the second to eleventh records are displayed. Constraints N/A Range [0, 5000] Default Value 0: The query starts from the first data record.
limit	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

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
instance_list	Array of Table 4	Definition Instance list
total_count	Integer	Definition Total number Range [0,10000]

**Table 4** DASInstanceInfo
Parameter	Type	Description
instance_id	String	Definition Instance ID, which uniquely identifies an instance. You can obtain the instance ID from the instance list or instance details. Range The value can contain 36 characters. Only letters and digits are allowed.
instance_name	String	Definition Instance name Range N/A
instance_status	String	Definition Instance status Range normal: An instance is normal. abnormal: An instance is abnormal. creating: An instance is being created. createfail: An instance failed to be created. data_disk_full: An instance is out of disk capacity. deleted: An instance has been deleted. shutdown: An instance is shut down.
version	String	Definition Instance version Range N/A
engine_type	String	Definition Engine type Range mysql: RDS for MySQL sqlserver: RDS for SQL Server postgresql: RDS for PostgreSQL mariadb: RDS for MariaDB mysql-turbo: RDS for TaurusDB taurus: TaurusDB gaussdbv5: GaussDB mongodb: DDS ddm: Distributed Database Middleware
ip	String	Definition Client IP address Range N/A
port	Integer	Definition Client port number Range N/A
cpu	Integer	Definition Number of CPU cores of an instance Range N/A
mem	Integer	Definition Instance memory size Range N/A
login_flag	Boolean	Definition Whether instance login is enabled Range N/A
slow_sql_flag	Boolean	Definition Whether Collect Slow Query Logs is enabled Range N/A
deadlock_flag	Boolean	Definition Whether deadlock analysis is enabled Range N/A
lock_blocking_flag	Boolean	Definition Whether the blocking mode is enabled Range N/A
charge_flag	Boolean	Definition Whether the current instance is billed Range N/A
full_sql_flag	Boolean	Definition Whether Collect All SQL Statements is enabled Range N/A

Example Requests

Viewing the instance list on the Intelligent O&M page

GET https://das.cn-north-1.myhuaweicloud.com/v3/054c630ff780d4cc2f40c00d7f6fb21d/instances?datastore_type=mysql

Example Responses

{ 
  "instance_list" : [ { 
    "instance_id" : "bcfa975193f1402fa11a6d4fd6baf5fbin01", 
    "instance_name" : "rds-sql", 
    "instance_status" : "normal", 
    "engine_type": "mysql",
    "version" : "5.7", 
    "ip" : "192.168.0.84", 
    "port" : 3306, 
    "cpu" : 2, 
    "mem" : 8, 
    "login_flag" : true, 
    "slow_sql_flag" : true, 
    "deadlock_flag" : false, 
    "lock_blocking_flag" : false, 
    "charge_flag" : true, 
    "full_sql_flag" : true 
  } ], 
  "total_count" : 2 
}

Status Codes

Status Code	Description
200	Success
400	Client error
500	Server error

Error Codes

See Error Codes.

Parent topic: Intelligent O&M

Previous topic: Exporting the Quantity Trend of Slow Query Logs

Next topic: Executing a SQL Diagnosis Task