Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying the Switch Status and Thresholds of the Current Query Queue
Updated on 2025-10-11 GMT+08:00

Querying the Switch Status and Thresholds of the Current Query Queue

Function

This API is used to query the switch status and thresholds of the current query queue. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/query-queue/rules

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

Standard HTAP instance ID, which is compliant with the UUID format.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in17. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 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 3 Response body parameter

Parameter

Type

Description

query_queue_rule

HtapQueryQueueRule object

Definition

Switch status and thresholds of the current query queue.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 HtapQueryQueueRule

Parameter

Type

Description

query_queue_max_queued_queries

Integer

Definition

Max. queuing queries.

Constraints

N/A

Range

0 or a positive integer

Default Value

1024

query_queue_pending_timeout_second

Integer

Definition

Max. queuing time (s).

Constraints

N/A

Range

0 or a positive integer

Default Value

300

query_queue_concurrency_limit

Integer

Definition

Max. queries that can be executed simultaneously.

Constraints

N/A

Range

0–100. The value 0 indicates no limit.

Default Value

0

query_queue_mem_used_pct_limit

Integer

Definition

Memory usage (%).

Constraints

N/A

Range

0–100. The value 0 indicates no limit.

Default Value

0

query_queue_cpu_used_pct_limit

Integer

Definition

CPU usage (%).

Constraints

N/A

Range

0–100. The value 0 indicates no limit.

Default Value

0

enable_query_queue_select

String

Definition

Whether the query queue is enabled.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

false

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying the switch status and thresholds of the current query queue

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin17/query-queue/rules

Example Response

Status code: 200

Success.

{
  "query_queue_rule" : [ {
    "query_queue_max_queued_queries" : 1024,
    "query_queue_pending_timeout_second" : 300,
    "query_queue_concurrency_limit" : 0,
    "query_queue_mem_used_pct_limit" : 0,
    "query_queue_cpu_used_pct_limit" : 0,
    "enable_query_queue_select" : "true"
  } ]
}

Status code: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.