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.
URI
GET /v3/{project_id}/instances
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
datastore_type |
Yes |
String |
Explanation: Database type Constraints: N/A Values: N/A Default value: N/A |
offset |
No |
Integer |
Explanation: 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 Values: [0, 5000] Default value: 0: The query starts from the first data record. |
limit |
No |
Integer |
Explanation: Number of records to be queried. If this parameter is set to 10, a maximum of 10 records can be displayed. Constraints: N/A Values: [0, 100] Default value: 20 |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
instance_list |
Array of Table 4 |
Explanation: Instance list Values: Array length: 0 to 200 characters |
total_count |
Integer |
Explanation: Total number Values: [0,10000] |
Parameter |
Type |
Description |
---|---|---|
instance_id |
String |
Explanation: Unique ID of an instance Values: The value can contain 32 characters. Only letters and digits are allowed. |
instance_name |
String |
Explanation: Instance name Values: N/A |
instance_status |
String |
Explanation: Instance status Values: N/A |
version |
String |
Explanation: Instance version Values: N/A |
engine_type |
String |
Explanation: Engine type Values: N/A |
ip |
String |
Explanation: Client IP address Values: N/A |
port |
Integer |
Explanation: Client port number Values: N/A |
cpu |
Integer |
Explanation: Number of CPU cores of an instance Values: N/A |
mem |
Integer |
Explanation: Instance memory size Values: N/A |
login_flag |
Boolean |
Explanation: Whether instance login is enabled Values: N/A |
slow_sql_flag |
Boolean |
Explanation: Whether Collect Slow Query Logs is enabled Values: N/A |
deadlock_flag |
Boolean |
Explanation: Whether deadlock analysis is enabled Values: N/A |
lock_blocking_flag |
Boolean |
Explanation: Whether the blocking mode is enabled Values: N/A |
charge_flag |
Boolean |
Explanation: Whether the current instance is billed Values: N/A |
full_sql_flag |
Boolean |
Explanation: Whether Collect All SQL Statements is enabled Values: N/A |
Example Request
Viewing the instance list on the Intelligent O&M page
GET https://das.cn-north-1.myhuaweicloud.com/v3/054c630ff780d4cc2f40c00d7f6fb21d/instances
Example Response
{ "instance_list" : [ { "instance_id" : "bcfa975193f1402fa11a6d4fd6baf5fbin01", "instance_name" : "rds-sql", "instance_status" : "ACTIVE", "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 |
Successful request |
400 |
Client error |
500 |
Server error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot