文档

UpdateAutoThrottleRulesAsync - 设置自动SQL限流配置参数

更新时间:

调用UpdateAutoThrottleRulesAsync接口,采用异步方式,批量设置指定数据库实例的自动SQL限流配置参数。

接口说明

说明 异步调用后不会立即返回完整结果,首先需要调用该接口获取 ResultId,然后使用返回数据的 ResultId,重新发起调用,直到 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:UpdateAutoThrottleRulesAsyncWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ConsoleContextstring

备用参数。

None
InstanceIdsstring

数据库实例 ID。

说明 数据格式为 JSONArray,例如['实例 ID1','实例 ID2'],实例 ID 间用英文逗号(,)分隔。
['rm-2ze8g2am97624****','rm-2ze9xrhze0709****']
CpuUsagedouble

CPU 利用率阈值,取值范围:70%~100%。

70
CpuSessionRelationstring

CPU 利用率阈值和活跃会话数阈值的逻辑关系。

  • AND:且。
  • OR:或。
OR
ActiveSessionslong

活跃会话数阈值。

  • 与 CPU 利用率阈值关系为 OR(或)时,大于等于 16。
  • 与 CPU 利用率阈值关系为 AND(且)时,大于等于 2。
16
AbnormalDurationdouble

触发自动 SQL 限流的异常的持续时间阈值,取值范围:大于等于 2 的正整数,单位:分钟。

2
MaxThrottleTimedouble

最大限流时长,取值为正整数,单位:分钟。

10
AllowThrottleStartTimestring

可限流时间段的开始时间(UTC 时间)。

00:00Z
AllowThrottleEndTimestring

可限流时间段的结束时间(UTC 时间)。

23:59Z
AutoKillSessionboolean

是否同时 KILL 执行中的异常 SQL:

说明 异常 SQL:与需要限流的 SQL 模板相同。
  • true:是。
  • false:否。
true
ResultIdstring

异步请求的 ID。

说明 异步调用后不会立即返回完整结果,首先需要调用该接口获取 ResultId,然后使用返回数据的 ResultId,重新发起调用,直到 isFinish 取值为 true 时,返回完整结果。即获取一次完整数据,至少需要调用该接口两次。
async__507044db6c4eadfa2dab9b084e80****

返回参数

名称类型描述示例值
object
Codelong

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
Dataobject

返回的数据。

Failboolean

请求是否失败:

  • true:是。

  • false:否。

false
ConfigResponseobject

批量设置的返回数据。

说明 异步请求完成时(即 isFinish 取值为 true 时)才会返回该数据。
TotalInstanceCountlong

总数据库实例数量。

2
ConfigSuccessInstanceCountlong

设置成功的数据库实例数量。

1
ConfigFailInstanceCountlong

设置失败的数据库实例数量。

1
ConfigSuccessInstanceListobject []

设置成功的数据库实例列表。

ConfigSuccessboolean

设置是否成功:

  • true:是。

  • false:否。

true
InstanceIdstring

数据库实例 ID。

rm-2ze8g2am97624****
ConfigFailInstanceListobject []

设置失败的数据库实例列表。

ConfigSuccessboolean

设置是否成功:

  • true:是。

  • false:否。

false
InstanceIdstring

数据库实例 ID。

rm-2ze9xrhze0709****
ErrorMessagestring

错误信息。

instance das autonomy service is off or can not find instance
ResultIdstring

异步请求 ID。

async__665ee69612f1627c7fd9f3c85075****
IsFinishboolean

异步请求是否执行完成:

  • true:是。

  • false:否。

true
Statestring

异步请求的执行状态:

  • RUNNING:正在运行。

  • SUCCESS:成功。

  • FAIL:失败。

SUCCESS
Completeboolean

异步请求是否执行完成:

  • true:是。

  • false:否。

true
Timestamplong

执行时间,格式为 Unix 时间戳,单位为毫秒。

1645668213000
RequestIdstring

请求 ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****
Successboolean

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "Fail": false,
    "ConfigResponse": {
      "TotalInstanceCount": 2,
      "ConfigSuccessInstanceCount": 1,
      "ConfigFailInstanceCount": 1,
      "ConfigSuccessInstanceList": [
        {
          "ConfigSuccess": true,
          "InstanceId": "rm-2ze8g2am97624****"
        }
      ],
      "ConfigFailInstanceList": [
        {
          "ConfigSuccess": false,
          "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错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-17OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)