# 查询SQL限流列表 - ListSqlLimit #### 功能介绍 查询SQL限流列表。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListSqlLimit)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:instance:get | read | - | - | rds:instance:list | - | #### URI - URI格式 GET /v3/{project_id}/instances/{instance_id}/sql-limit?db_name={db_name}\&offset={offset}\&limit={limit} - 参数说明 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | db_name | 是 | String | **参数解释**： 数据库名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | offset | 否 | Integer | **参数解释**： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制**： 不涉及。 **取值范围**： 大于等于0的整数。 **默认取值**： 默认为0，偏移0条数据，表示从第一条数据开始查询。 | | limit | 否 | Integer | **参数解释**： 查询记录数。 **约束限制**： 不涉及。 **取值范围**： \[1, 100\] **默认取值**： 10 | #### 请求消息 无。 #### 请求示例 ``` GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/sql-limit?db_name=postgres&offset=0&limit=10 ``` #### 响应消息 - 正常响应要素说明 表2字段说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | count | Integer | **参数解释**： SQL限流总数。 **取值范围**： 不涉及。 | | sql_limit_objects | Array of objects | **参数解释**： SQL限流详情。 请参见[表3]。 | 表3sql_limit_objects字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | id | String | **参数解释**： SQL限流ID。 **取值范围**： 不涉及。 | | query_id | String | **参数解释**： 由SQL的语法解析树计算出的内部哈希码。 **取值范围**： -9223372036854775808\~ 9223372036854775807。 | | query_string | String | **参数解释**： SQL语句的文本形式。 **取值范围**： 不涉及。 | | max_concurrency | Integer | **参数解释**： 同时执行的SQL数量。 **取值范围**： -1\~50000，小于等于0表示不限制。 | | is_effective | Boolean | **参数解释**： SQL限流规则是否生效。 **取值范围**： - true：生效。 - false：不生效。 | | max_waiting | Integer | **参数解释**： 最大等待时间，单位为秒。 **取值范围**： 不涉及。 | | search_path | String | **参数解释**： 数据库对象的schema搜索路径。 **取值范围**： public | - 正常响应样例 ``` { "count": 2, "sql_limit_objects": [ { "id": "3", "query_id": "1147616880456321454", "query_string": "select 1;", "max_concurrency": 10, "is_effective": false, "max_waiting": 10, "search_path": "public" }, { "id": "4", "query_id": "-7472493489976133824", "query_string": "select * from pg_type;", "max_concurrency": 10, "is_effective": false, "max_waiting": 10, "search_path": "public" } ] } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。