Updated on 2024-08-05 GMT+08:00

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

db_user_id

Yes

String

Database user ID.

user

No

String

User.

database

No

String

Database.

offset

No

Integer

Offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number.

limit

No

Integer

Number of records displayed on each page. The default value is 20 and the maximum value is 100.

node_id

No

String

Node ID.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

X-Language

No

String

Language.

The value can be:

  • zh-cn
  • en-us

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

processes

Array of Process objects

List of sessions.

count

Long

Total records.

Table 5 Process

Parameter

Type

Description

id

String

Session ID.

user

String

User.

host

String

Host.

database

String

Database.

command

String

Command.

time

String

Session duration.

state

String

Status.

sql

String

SQL statement.

trx_executed_time

String

Transaction duration.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 8

Maximum length: 36

error_msg

String

Error message.

Minimum length: 2

Maximum length: 512

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 8

Maximum length: 36

error_msg

String

Error message.

Minimum length: 2

Maximum length: 512

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
}

Status Code

Status Code

Description

200

Success.

400

Bad request.

500

Internal server error.

Error Code

For details, see Error Codes.