# 设置当前查询队列阈值 - SetHtapQueryQueuesRule #### 功能介绍 设置当前查询队列阈值。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | 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](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： HTAP标准版实例ID，严格匹配UUID规则。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in17，且长度为36个字符。 **默认值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认值**： 不涉及。 | | X-Language | 是 | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us - zh-cn **默认值**： en-us。 | | Content-Type | 是 | String | **参数解释**： 内容类型。 **约束限制**： 不涉及。 **取值范围**： application/json。 **默认值**： application/json。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | query_queue_rule | 是 | [HtapQueryQueueRule] object | **参数解释**： 设置SQL限流规则。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认值**： 不涉及。 | 表4HtapQueryQueueRule | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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** ``` { "status" : "success", "msg" : "success" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 设置当前查询队列阈值。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class SetHtapQueryQueuesRuleSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("")) .build(); SetHtapQueryQueuesRuleRequest request = new SetHtapQueryQueuesRuleRequest(); request.withInstanceId("{instance_id}"); OperateHtapQueryQueueRuleReq body = new OperateHtapQueryQueueRuleReq(); HtapQueryQueueRule queryQueueRulebody = new HtapQueryQueueRule(); queryQueueRulebody.withQueryQueueMaxQueuedQueries(1024) .withQueryQueuePendingTimeoutSecond(300) .withQueryQueueConcurrencyLimit(0) .withQueryQueueMemUsedPctLimit(0) .withQueryQueueCpuUsedPctLimit(0) .withEnableQueryQueueSelect("true"); body.withQueryQueueRule(queryQueueRulebody); request.withBody(body); try { SetHtapQueryQueuesRuleResponse response = client.setHtapQueryQueuesRule(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 设置当前查询队列阈值。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("")) \ .build() try: request = SetHtapQueryQueuesRuleRequest() request.instance_id = "{instance_id}" queryQueueRulebody = HtapQueryQueueRule( 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" ) request.body = OperateHtapQueryQueueRuleReq( query_queue_rule=queryQueueRulebody ) response = client.set_htap_query_queues_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 设置当前查询队列阈值。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.SetHtapQueryQueuesRuleRequest{} request.InstanceId = "{instance_id}" enableQueryQueueSelectQueryQueueRule:= "true" queryQueueRulebody := &model.HtapQueryQueueRule{ QueryQueueMaxQueuedQueries: int32(1024), QueryQueuePendingTimeoutSecond: int32(300), QueryQueueConcurrencyLimit: int32(0), QueryQueueMemUsedPctLimit: int32(0), QueryQueueCpuUsedPctLimit: int32(0), EnableQueryQueueSelect: &enableQueryQueueSelectQueryQueueRule, } request.Body = &model.OperateHtapQueryQueueRuleReq{ QueryQueueRule: queryQueueRulebody, } response, err := client.SetHtapQueryQueuesRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDB/sdk?api=SetHtapQueryQueuesRule)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。