文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ 设置当前查询队列阈值- SetHtapQueryQueuesRule
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置当前查询队列阈值 - SetHtapQueryQueuesRule

功能介绍

设置当前查询队列阈值。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:param:update

    Write

    -

    -

    gaussdb:param:modify

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

HTAP标准版实例ID，严格匹配UUID规则。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in17，且长度为36个字符。

默认值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

内容类型。

约束限制：

不涉及。

取值范围：

application/json。

默认取值：

application/json。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

query_queue_rule

是

HtapQueryQueueRule object

参数解释：

设置SQL限流规则。

约束限制：

不涉及。

取值范围：

不涉及。

默认值：

不涉及。
表4 HtapQueryQueueRule

参数

是否必选

参数类型

描述

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

参数解释：

查询队列开关状态。

约束限制：

不涉及。

取值范围：

  • true：表示开启。

  • false：表示关闭。

默认值：

false。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释：

响应返回结果。

取值范围：

  • success：成功。

  • failed：失败。

msg

String

参数解释：

响应错误信息。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

设置当前查询队列阈值。

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"
  }
}

响应示例

状态码：200

Success.

{
  "status" : "success",
  "msg" : "success"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版