GetRunningSqlConcurrencyControlRules - 获取正在执行的限流规则

调用GetRunningSqlConcurrencyControlRules接口,获取正在执行的限流规则。

接口说明

本接口适用的数据库引擎为:

  • RDS MySQL
  • PolarDB MySQL

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:GetRunningSqlConcurrencyControlRulesList
  • DAS
    acs:hdm:*:{#accountId}:*

请求参数

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

备用参数。

None
InstanceIdstring

实例ID。

说明仅支持RDS MySQL和 PolarDB MySQL实例。
rm-2ze1jdv45i7l6****
PageNoLong

页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。

1
PageSizeLong

每页最大记录数,取值大于0且不超过Integer数据类型的最大值,默认值为10。

10

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

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

详细信息列表,包括信息总数、错误码等。

TotalLong

总记录数。

2
Listarray

返回信息列表。

object
ItemIdLong

当前实例的限流规则ID。

16
SqlTypestring

选择SQL的类型。取值:

  • SELECT
  • UPDATE
  • DELETE
SELECT
InstanceIdstring

实例ID。

rm-2ze1jdv45i7l6****
SqlKeywordsstring

需要限流的SQL关键词。

说明多个关键词间用波浪线(~)分隔,SQL语句中需要同时包含这些关键词才会触发限流规则。
call~open~api~test~4~from~POP
StartTimeLong

获取正在执行的限流规则的开始时间,格式为Unix时间戳,单位为毫秒。

1608888296000
KeywordsHashstring

哈希值,根据输入的限流关键词计算出来的值。

b0b8aceeb43baea87b219c81767b****
ConcurrencyControlTimeLong

SQL限流的生效时长,单位为秒。

说明限流规则仅在生效时间内开启。
600
UserIdstring

阿里云账号ID。

testxxx
MaxConcurrencystring

SQL最大并发数,取值为大于或等于1的整数。

说明当包含关键词的SQL达到最大并发数时会触发限流策略。
2
Statusstring

限流规则的生效状态,取值为Open:限流规则正在生效中。

Open
RequestIdstring

请求ID。

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

请求是否执行成功:

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

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=GetRunningSqlConcurrencyControlRules
&ConsoleContext=None
&InstanceId=rm-2ze1jdv45i7l6****
&PageNo=1
&PageSize=10
&公共请求参数

正常返回示例

JSON格式

{
    "Code": "200",
    "Message": "Successful",
    "Data": {
        "Total": 2,
        "List": [
            {
                "ItemId": 16,
                "SqlType": "SELECT",
                "InstanceId": "rm-2ze1jdv45i7l6****",
                "SqlKeywords": "call~open~api~test~4~from~POP",
                "StartTime": 1608888296000,
                "KeywordsHash": "b0b8aceeb43baea87b219c81767b****",
                "ConcurrencyControlTime": 600,
                "UserId": "testxxx",
                "MaxConcurrency": "2",
                "Status": "Open"
            }
        ]
    },
    "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
    "Success": "true"
}

XML格式

<GetRunningSqlConcurrencyControlRulesResponse>
    <Code>200</Code>
    <Message>Successful</Message>
    <Data>
        <Total>2</Total>
        <List>
            <ItemId>16</ItemId>
            <SqlType>SELECT</SqlType>
            <InstanceId>rm-2ze1jdv45i7l6****</InstanceId>
            <SqlKeywords>call~open~api~test~4~from~POP</SqlKeywords>
            <StartTime>1608888296000</StartTime>
            <KeywordsHash>b0b8aceeb43baea87b219c81767b****</KeywordsHash>
            <ConcurrencyControlTime>600</ConcurrencyControlTime>
            <UserId>testxxx</UserId>
            <MaxConcurrency>2</MaxConcurrency>
            <Status>Open</Status>
        </List>
    </Data>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Success>true</Success>
</GetRunningSqlConcurrencyControlRulesResponse>

错误码

Http code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误

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

阿里云首页 数据库自治服务 DAS 相关技术圈