# 开启自治限流 - SetAutoSqlLimiting #### 功能介绍 开启自治限流。 #### 调用方法 请参见[如何调用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:instance:setSqlFilterRules | Write | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | gaussdb:param:modify | - | #### URI PUT /v3/{project_id}/instances/{instance_id}/auto-sql-limiting 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID，此参数是实例的唯一标识。 获取方法请参见[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstancesUnifyStatus.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为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。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | auto_sql_limiting_rules | 是 | Array of [AutoSqlLimitingRule] objects | **参数解释**： 开启自治限流规则。 **约束限制**： 不涉及。 | 表4AutoSqlLimitingRule | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | node_id | 是 | String | **参数解释**： 节点ID。 获取方法请参见[查询实例详情](https://support.huaweicloud.com/api-taurusdb/ShowGaussMySqlInstanceInfoUnifyStatus.html)。 **约束限制**： 节点角色必须为主节点。 **取值范围**： 只能由英文字母、数字组成，前面为UUID，后缀为no07，长度为36个字符。 **默认取值**： 不涉及。 | | start_time | 是 | String | **参数解释**： 自治限流规则每天生效开始时间。 **约束限制**： 格式为 "hh:mm"。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | end_time | 是 | String | **参数解释**： 自治限流规则每天生效结束时间。 **约束限制**： 格式为 "hh:mm"。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | condition | 是 | String | **参数解释**： 限流策略CPU利用率和活跃会话数的关联关系。 **约束限制**： 不涉及。 **取值范围**： - and：且。 - or：或。 **默认取值**： 不涉及。 | | cpu_usage | 是 | Integer | **参数解释**： 限流策略CPU利用率。 **约束限制**： 不涉及。 **取值范围**： \[70\~100\]。 **默认取值**： 不涉及。 | | active_sessions | 是 | Integer | **参数解释**： 限流策略活跃会话数。 **约束限制**： 不涉及。 **取值范围**： \[1\~5000\]。 **默认取值**： 不涉及。 | | clear_time | 是 | Integer | **参数解释**： 每次最大限流时长（分钟）。 **约束限制**： 不涉及。 **取值范围**： \[1\~1440\]。 **默认取值**： 不涉及。 | | duration | 是 | Integer | **参数解释**： 限流策略满足限流条件的事件持续时间（分钟）。 **约束限制**： 不涉及。 **取值范围**： \[2\~60\]。 **默认取值**： 不涉及。 | | max_concurrency | 是 | Integer | **参数解释**： 最大并发数。 **约束限制**： 不涉及。 **取值范围**： \[0\~1000000000\]。 **默认取值**： 不涉及。 | | retain_sql_rule | 是 | Boolean | **参数解释**： 是否保留已有的SQL限流规则。 **约束限制**： 不涉及。 **取值范围**： - true：保留已有的SQL限流规则。 - false：清理已有的SQL限流规则。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 开启自治限流任务ID。 **取值范围**： 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 开启自治限流。 ``` PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/auto-sql-limiting { "auto_sql_limiting_rules" : [ { "node_id" : "a4e0f43f6ee2459fa3ac27474cb5991cno07", "start_time" : "00:00", "end_time" : "01:01", "condition" : "and", "cpu_usage" : 70, "active_sessions" : 3, "duration" : 2, "clear_time" : 3, "max_concurrency" : 1000, "retain_sql_rule" : true } ] } ``` #### 响应示例 **状态码：200** ``` { "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3" } ``` #### 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.*; import java.util.List; import java.util.ArrayList; public class SetAutoSqlLimitingSolution { 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(); SetAutoSqlLimitingRequest request = new SetAutoSqlLimitingRequest(); request.withInstanceId("{instance_id}"); SetAutoSqlLimitingReq body = new SetAutoSqlLimitingReq(); List listbodyAutoSqlLimitingRules = new ArrayList<>(); listbodyAutoSqlLimitingRules.add( new AutoSqlLimitingRule() .withNodeId("a4e0f43f6ee2459fa3ac27474cb5991cno07") .withStartTime("00:00") .withEndTime("01:01") .withCondition("and") .withCpuUsage(70) .withActiveSessions(3) .withClearTime(3) .withDuration(2) .withMaxConcurrency(1000) .withRetainSqlRule(true) ); body.withAutoSqlLimitingRules(listbodyAutoSqlLimitingRules); request.withBody(body); try { SetAutoSqlLimitingResponse response = client.setAutoSqlLimiting(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 = SetAutoSqlLimitingRequest() request.instance_id = "{instance_id}" listAutoSqlLimitingRulesbody = [ AutoSqlLimitingRule( node_id="a4e0f43f6ee2459fa3ac27474cb5991cno07", start_time="00:00", end_time="01:01", condition="and", cpu_usage=70, active_sessions=3, clear_time=3, duration=2, max_concurrency=1000, retain_sql_rule=True ) ] request.body = SetAutoSqlLimitingReq( auto_sql_limiting_rules=listAutoSqlLimitingRulesbody ) response = client.set_auto_sql_limiting(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.SetAutoSqlLimitingRequest{} request.InstanceId = "{instance_id}" var listAutoSqlLimitingRulesbody = []model.AutoSqlLimitingRule{ { NodeId: "a4e0f43f6ee2459fa3ac27474cb5991cno07", StartTime: "00:00", EndTime: "01:01", Condition: "and", CpuUsage: int32(70), ActiveSessions: int32(3), ClearTime: int32(3), Duration: int32(2), MaxConcurrency: int32(1000), RetainSqlRule: true, }, } request.Body = &model.SetAutoSqlLimitingReq{ AutoSqlLimitingRules: listAutoSqlLimitingRulesbody, } response, err := client.SetAutoSqlLimiting(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=SetAutoSqlLimiting)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。