DescribeSQLRateLimitingRules - 查询SQL限流规则

更新时间:
复制 MD 格式

查询SQL限流规则信息

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeSQLRateLimitingRules

list

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

DBClusterId

string

是

集群 ID。注意:SQL 限流功能仅支持 PostgreSQL 和 Oracle 引擎类型的集群,MySQL 引擎集群不支持此功能。

pc-*************

RuleNameList

string

否

需要查询的 SQL 限流规则名称。支持输入多个规则名称进行批量查询,多个名称间用英文逗号(,)分隔。

说明

您可以通过 DescribeSQLRateLimitingRules 接口查看目标集群下所有防火墙规则的详情,包括规则名称。

testrule

MaxResults

integer

否

分页查询时每页行数。

最大值为 100。

默认值为 10。

10

NextToken

string

否

分页 token。

AAAAARbaCuN6hiD08qrLdwJ9Fh3QbdIPYBaCDXsvvjLHCQfi

返回参数

名称

类型

描述

示例值

object

Schema of Response

{}

Data

object

结果集。

{}

RuleList

array

规则列表

[]

string

规则对象。

{"id":"test","enabled":"true","match_mode":"0","template":"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==","user":"","database":"","waiting":1024,"endpoint":"[{"EndpointName":"pe-***********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"}]","throttle_mode":0,"concurrency":1}

MaxResults

integer

本次读取的最大数据量,默认值为 10。

10

Message

string

请求返回消息。

说明

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

Successful

NextToken

string

下一页查询凭证。

AAAAARbaCuN6hiD08qrLdwJ9Fh0vHYf39hc0J5qELgsazkBk

RequestId

string

请求 ID。

22C0ACF0-DD29-4B67-9190-B7A48C******

示例

正常返回示例

JSON格式

{
  "Data": {
    "RuleList": [
      "{\"id\":\"test\",\"enabled\":\"true\",\"match_mode\":\"0\",\"template\":\"dXBkYXRlIHQgc2V0IGEgPSAxIHdoZXJlIGlkID0gMQ==\",\"user\":\"\",\"database\":\"\",\"waiting\":1024,\"endpoint\":\"[{\"EndpointName\":\"pe-***********\",\"EndpointType\":\"Cluster\",\"DBEndpointDescription\":\"Cluster Address\"}]\",\"throttle_mode\":0,\"concurrency\":1}"
    ]
  },
  "MaxResults": 10,
  "Message": "Successful",
  "NextToken": "AAAAARbaCuN6hiD08qrLdwJ9Fh0vHYf39hc0J5qELgsazkBk",
  "RequestId": "22C0ACF0-DD29-4B67-9190-B7A48C******"
}

错误码

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

变更历史

更多信息,参考变更详情。