Querying Instance Sessions
Function
Query instance sessions by database or user. Currently, this function is supported only for MySQL DB instances.
URI
GET /v3/{project_id}/instances/{instance_id}/processes
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 |
instance_id |
Yes |
String |
Explanation: Unique ID of an instance Constraints: N/A Values: The value can contain 32 characters. Only letters and digits are allowed. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
db_user_id |
Yes |
String |
Explanation: Database user ID, that is, ID of a connection established between the database account and the database. A database user ID is created by calling the API in Registering a Database User. Constraints: N/A Values: The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed. Default value: N/A |
user |
No |
String |
Explanation: Database user Constraints: At least one of the user and database parameters must be specified. Values: N/A Default value: N/A |
database |
No |
String |
Explanation: Database name Constraints: At least one of the user and database parameters must be specified. 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, 2^31-1] 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: [1, 100] Default value: 100 |
node_id |
No |
String |
Explanation: Unique ID of a node Constraints: N/A Values: The value can contain 32 characters. Only letters and digits are allowed. Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
processes |
Array of Process objects |
Explanation: Sessions Values: N/A |
count |
Long |
Explanation: Total number of records Values: [0, 2^31-1]. The actual value depends on the query result. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Explanation: Session ID Values: N/A |
user |
String |
Explanation: Username Values: N/A |
host |
String |
Explanation: Host Values: N/A |
database |
String |
Explanation: Database name Values: N/A |
command |
String |
Explanation: Command Values: N/A |
time |
String |
Explanation: Session duration Values: N/A |
state |
String |
Explanation: Status Values: N/A |
sql |
String |
Explanation: SQL statement Values: N/A |
trx_executed_time |
String |
Explanation: Transaction duration Values: N/A |
Example Request
Querying instance sessions
GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/processes?db_user_id=2c250598-1e3c-4d31-bc19-be1d866247e6&offset=0&limit=10
Example Responses
Status code: 200
{ "processes" : [ { "id" : "1", "user" : "event_scheduler", "host" : "localhost", "database" : "--", "command" : "Daemon", "time" : "4260107", "state" : "Waiting on empty queue", "sql" : "", "trx_executed_time" : "0" } ], "count" : 1 }
Status Code
Status Code |
Description |
---|---|
200 |
Successful request |
400 |
Bad request |
500 |
Internal server error |
Error Code
For details, 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