Querying User Session Threads on a Node

Function

This API is used to query user session threads on a TaurusDB node by page, similar to the show processlist command. Internal session threads are not returned. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/instances/{instance_id}/nodes/{node_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 contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
node_id	Yes	String	Definition Node ID, which uniquely identifies a node. Constraints N/A Range The value contains 36 characters with a suffix of no07. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value cannot be a negative number. Range ≥ 0 Default Value 0
limit	No	Integer	Definition Number of records to be queried. Constraints The value cannot be a negative number. Range 1–100 Default Value 100

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
processes	Array of TaurusDbProcessInfo objects	Definition User session threads.
total_count	Integer	Definition Total number of user session threads on a node. Range ≥ 0

**Table 5** TaurusDbProcessInfo
Parameter	Type	Description
id	Long	Definition ID of a user session thread.
user	String	Definition User who starts the session thread.
host	String	Definition Host and port that send requests.
db	String	Definition Name of the database that is being accessed.
command	String	Definition Command that is being executed.
time	Long	Definition How many seconds the user session thread remains in the current state.
state	String	Definition Status of the SQL statement that is being executed.
info	String	Definition Additional information, which is usually the statement that is being executed.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying the first 100 user session threads on a TaurusDB node

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/nodes/18663926eacb443d98dc20f8620f28f2no07/processes?offset=0&limit=100

Example Response

Status code: 200

Success.

{
  "processes" : [ {
    "id" : 2075425,
    "user" : "root",
    "host" : "100.98.212.252:29285",
    "db" : null,
    "command" : "Query",
    "time" : 103,
    "state" : "User sleep",
    "info" : "select sleep(1000)"
  }, {
    "id" : 2075426,
    "user" : "root",
    "host" : "100.98.212.252:29285",
    "db" : null,
    "command" : "Query",
    "time" : 105,
    "state" : "User sleep",
    "info" : "show processlist"
  } ],
  "total_count" : 2
}