查询当前查询队列开关和阈值
功能介绍
查询当前查询队列开关和阈值。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/instances/{instance_id}/query-queue/rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认值: 不涉及。 |
instance_id |
是 |
String |
参数解释: HTAP标准版实例ID,严格匹配UUID规则。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in17,且长度为36个字符。 默认值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
X-Language |
是 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围:
默认值: en-us。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
query_queue_rule |
HtapQueryQueueRule object |
参数解释: 查询当前查询队列开关和阈值。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
query_queue_max_queued_queries |
Integer |
参数解释: 查询队列中的查询数量上限。 约束限制: 不涉及。 取值范围: 非负整数。 默认值: 1024。 |
query_queue_pending_timeout_second |
Integer |
参数解释: 查询阻塞时间上限。 约束限制: 不涉及。 取值范围: 非负整数。 默认值: 300。 |
query_queue_concurrency_limit |
Integer |
参数解释: 查询队列并发值。 约束限制: 不涉及。 取值范围: 0~100的整数,0表示没有限制。 默认值: 0。 |
query_queue_mem_used_pct_limit |
Integer |
参数解释: 内存使用百分比。 约束限制: 不涉及。 取值范围: 0~100的整数,0表示没有限制。 默认值: 0。 |
query_queue_cpu_used_pct_limit |
Integer |
参数解释: CPU使用百分比。 约束限制: 不涉及。 取值范围: 0~100的整数,0表示没有限制。 默认值: 0。 |
enable_query_queue_select |
String |
参数解释: 查询队列开关状态。 约束限制: 不涉及。 取值范围:
默认值: false。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
查询当前查询队列开关和阈值。
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin17/query-queue/rules
响应示例
状态码: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" } ] }
状态码:400
Client error.
{ "error_code" : "DBS.200022", "error_msg" : "实例不存在" }
状态码
状态码 |
描述 |
---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。