调用UpdateAutoThrottleRulesAsync接口,采用异步方式,批量设置指定数据库实例的自动SQL限流配置参数。
接口说明
说明异步调用后不会立即返回完整结果,当返回数据中isFinish取值为false时,请等待1s后重新发起调用,直到isFinish取值为true时,返回完整结果。
使用该接口需满足以下前提条件:
在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。
目标数据库实例已开启自治服务,详情请参见自治中心。
目标数据库实例为:
- RDS MySQL 5.6、5.7、 8.0高可用版、三节点企业版。
- PolarDB MySQL 5.6集群版、5.7集群版、 8.0集群版、8.0高压缩引擎(X-Engine)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
hdm:UpdateAutoThrottleRulesAsync | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ConsoleContext | string | 否 | 备用参数。 | None |
InstanceIds | string | 是 | 数据库实例ID。 说明数据格式为JSONArray,例如 ['实例ID1','实例ID2'] ,实例ID间用英文逗号(,)分隔。 | ['rm-2ze8g2am97624****','rm-2ze9xrhze0709****'] |
CpuUsage | double | 否 | CPU利用率阈值,取值范围:70%~100%。 | 70 |
CpuSessionRelation | string | 是 | CPU利用率阈值和活跃会话数阈值的逻辑关系。
| OR |
ActiveSessions | long | 否 | 活跃会话数阈值。
| 16 |
AbnormalDuration | double | 否 | 触发自动SQL限流的异常的持续时间阈值,取值范围:大于等于2的正整数,单位:分钟。 | 2 |
MaxThrottleTime | double | 否 | 最大限流时长,取值为正在数,单位:分钟。 | 10 |
AllowThrottleStartTime | string | 是 | 可限流时间段的开始时间(UTC时间)。 | 00:00Z |
AllowThrottleEndTime | string | 是 | 可限流时间段的结束时间(UTC时间)。 | 23:59Z |
AutoKillSession | boolean | 否 | 是否同时KILL执行中的异常SQL: 说明异常SQL:与需要限流的SQL模板相同。
| true |
ResultId | string | 否 | 异步请求的ID。 说明对于相同调用请求,首次调用时不输入,后续调用时使用首次调用返回数据中的该字段。 | async__507044db6c4eadfa2dab9b084e80**** |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "Successful",
"Data": {
"Fail": true,
"ConfigResponse": {
"TotalInstanceCount": 2,
"ConfigSuccessInstanceCount": 1,
"ConfigFailInstanceCount": 1,
"ConfigSuccessInstanceList": [
{
"ConfigSuccess": true,
"InstanceId": "rm-2ze8g2am97624****"
}
],
"ConfigFailInstanceList": [
{
"ConfigSuccess": true,
"InstanceId": "rm-2ze9xrhze0709****",
"ErrorMessage": "instance das autonomy service is off or can not find instance"
}
]
},
"ResultId": "async__665ee69612f1627c7fd9f3c85075****",
"IsFinish": true,
"State": "SUCCESS",
"Complete": true,
"Timestamp": 1645668213000
},
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
访问错误中心查看更多错误码。