Querying Instance Sessions

Function

Query instance sessions by database or user. Currently, this function is supported only for MySQL DB instances.

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::showCloudDBAInfo	Read	-	-	-	-

URI

GET /v3/{project_id}/instances/{instance_id}/processes

**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, including only letters and digits. Default Value N/A
instance_id	Yes	String	Definition Unique ID of an instance Constraints N/A Range The value can contain 32 characters, including only letters and digits. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
db_user_id	Yes	String	Definition 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 Creating a Database User. Constraints N/A Range The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value N/A
user	No	String	Definition Database user Constraints At least one of the user and database parameters must be specified. Range N/A Default Value N/A
database	No	String	Definition Database name Constraints At least one of the user and database parameters must be specified. Range N/A 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, 2^31-1] 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 [1, 100] Default Value 100
node_id	No	String	Definition Unique ID of a node Constraints N/A Range The value can contain 32 characters, including only letters and digits. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
processes	Array of Process objects	Definition Sessions Range N/A
count	Long	Definition Total number of records Range [0, 2^31-1]. The actual value depends on the query result.

**Table 4** Process
Parameter	Type	Description
id	String	Definition Session ID Range N/A
user	String	Definition Username Range N/A
host	String	Definition Host Range N/A
database	String	Definition Database name Range N/A
command	String	Definition Command Range N/A
time	String	Definition Session duration Range N/A
state	String	Definition Status Range Sleep: Wait for a new request from a client. Searching rows for update: Scan rows in the first phase. Sending data: Read and process rows to be queried. Sorting for group / order: Sort memory or disks. Waiting for table metadata lock: Wait for a metadata lock. Locked: Wait for release of row-level or table-level locks. Statistics: Calculate statistics. Updating: Find rows to be updated and modify them. Copying to tmp table on disk: The temporary result set is being moved from memory to disks.
sql	String	Definition SQL statement Range N/A
trx_executed_time	String	Definition Transaction duration Range N/A

Example Requests

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
}