Setting Thresholds for the Current Query Queue
Function
This API is used to set thresholds for the current query queue. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
PUT /v3/{project_id}/instances/{instance_id}/query-queue/rules
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
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 |
Content-Type |
Yes |
String |
Definition Content type. Constraints N/A Range application/json Default Value application/json |
X-Language |
No |
String |
Definition Request language type. Constraints N/A Range Default Value en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
query_queue_rule |
Yes |
HtapQueryQueueRule object |
Definition SQL throttling rule. Constraints N/A Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
query_queue_max_queued_queries |
Yes |
Integer |
Definition Max. queuing queries. Constraints N/A Range 0 or a positive integer Default Value 1024 |
query_queue_pending_timeout_second |
Yes |
Integer |
Definition Max. queuing time (s). Constraints N/A Range 0 or a positive integer Default Value 300 |
query_queue_concurrency_limit |
Yes |
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 |
Yes |
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 |
Yes |
Integer |
Definition CPU usage (%). Constraints N/A Range 0–100. The value 0 indicates no limit. Default Value 0 |
enable_query_queue_select |
No |
String |
Definition Whether to enable the query queue. Constraints N/A Range Default Value false |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
status |
String |
Definition Response result. Range |
msg |
String |
Definition Response error information. Range N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Request
Setting thresholds for the current query queue
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin17/query-queue/rules { "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" } }
Example Response
Status code: 200
Success.
{ "status" : "success", "msg" : "success" }
Status Code
For details, see Status Codes.
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