# 查询SQL限流任务列表 #### 功能介绍 根据指定条件查询限流任务列表。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListLimitTask)中调试该接口。 #### URI GET /v3/{project_id}/instances/{instance_id}/limit-task-list 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_scope | 否 | String | **参数解释** **：** 限流任务范围。 **约束限制** **：** 不涉及。 **取值范围** **：** 目前支持SQL，SESSION两种级别范围。 **默认取值：** 不涉及。 | | limit_type | 否 | String | **参数解释** **：** 限流类型。 **约束限制** **：** 不涉及。 **取值范围** **：** - SQL_ID：模板的SQL_ID。 - SQL_TYPE：SQL类型。 - SESSION_ACTIVE_MAX_COUNT：利用率阈值。 **默认取值** **：** 不涉及。 | | limit_type_value | 否 | String | **参数解释** **：** 限流类型值，支持模糊匹配。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | task_name | 否 | String | **参数解释** **：** 限流任务名，支持模糊匹配。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | sql_model | 否 | String | **参数解释** **：** SQL模板，支持模糊匹配。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | rule_name | 否 | String | **参数解释** **：** 规则名。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | start_time | 否 | String | **参数解释** **：** 限流任务开始时间。 **约束限制** **：** 格式为yyyy-mm-ddThh:mm:ssZ,当前时间指UTC时间。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | end_time | 否 | String | **参数解释** **：** 限流任务结束时间。 **约束限制** **：** 格式为yyyy-mm-ddThh:mm:ssZ,当前时间指UTC时间。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | offset | 否 | Integer | 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制** **：** 必须为数字，不能为负数。 **取值范围** **：** 0\~10000 **默认取值** **：** 0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释** **：** 查询记录数。 **约束限制** **：** 不能为负数。 **取值范围** **：** \[1,100\] **默认取值** **：** 10 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围** **：** - **zh-cn：**中文 - **en-us** **：**英文 **默认取值** **：** **en-us** | #### 响应参数 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | limit_task_list | Array of objects | **参数解释** **：** 限流任务列表，详情请参见[表5]。 | | limit | Integer | **参数解释** **：** 查询记录数。 **取值范围：** 0\~100 | | offset | Integer | **参数解释** **：** 索引位置。 **取值范围：** 0\~10000 | | total_count | Integer | **参数解释** **：** 总数。 **取值范围：** 0\~10000 | 表5ListLimitTaskResponseResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | **参数解释** **：** 限流任务ID。 **取值范围** **：** 不涉及。 | | task_scope | String | **参数解释** **：** 任务限流范围。 **取值范围** **：** 目前支持SQL，SESSION两种级别范围。 | | limit_type | String | **参数解释** **：** 任务限流类型。 **取值范围** **：** - SQL_ID：模板的SQL_ID。 - SQL_TYPE：SQL类型。 - SESSION_ACTIVE_MAX_COUNT：利用率阈值。 | | limit_type_value | String | **参数解释** **：** 任务限流类型值。 **取值范围** **：** - 当"limit_type"为SQL_ID类型时，该值为选中模板的sql_id。 - 当"limit_type"为SQL_TYPE类型时，值为SQL类型，为select，update，insert，delete，merge的一种。 - 当"limit_type"为SESSION_ACTIVE_MAX_COUNT类型时，该值为CPU_OR_MEMORY。 | | task_name | String | **参数解释** **：** 限流任务名。 **取值范围** **：** 不涉及。 | | databases | String | **参数解释** **：** 实例的数据库列表，每个数据库以英文逗号形式隔开。 **取值范围** **：** 不涉及。 | | sql_model | String | **参数解释** **：** SQL模板，仅当任务类型为SQL_ID时，返回该值。 **取值范围** **：** 不涉及。 | | key_words | String | **参数解释** **：** 关键词，仅当任务类型为SQL_TYPE时，返回该值。 **取值范围** **：** 不涉及。 | | status | String | **参数解释** **：** 限流任务状态。 **取值范围** **：** - CREATING：表示正在创建。 - UPDATING：表示正在更新数据。 - DELETING：表示正在删除数据。 - WAIT_EXECUTE：表示操作处于等待执行状态。 - EXECUTING：表示操作正在执行中。 - TIME_OVER：表示操作超时。 - DELETED：表示对象已被删除。 - CREATE_FAILED：表示创建操作失败。 - UPDATE_FAILED：表示更新操作失败。 - DELETE_FAILED：表示删除操作失败。 - EXCEPTION：表示操作过程中发生了异常或错误。 - NODE_SHUT_DOWN：表示节点已关闭。 | | instance_id | String | **参数解释** **：** 实例ID。 **取值范围** **：** 不涉及。 | | rule_name | String | **参数解释** **：** 规则名。 **取值范围** **：** 不涉及。 | | parallel_size | Integer | **参数解释** **：** 并发数。 **取值范围** **：** \[0, 2147483647\] | | start_time | String | **参数解释** **：** 限流任务开始时间，格式为yyyy-mm-ddThh:mm:ssZ。当"task_scope"为SQL时会返回该参数。 **取值范围** **：** 不涉及。 | | end_time | String | **参数解释** **：** 限流任务结束时间，格式为yyyy-mm-ddThh:mm:ssZ。当"task_scope"为SQL时会返回该参数。 **取值范围** **：** 不涉及。 | | cpu_utilization | Integer | **参数解释** **：** CPU利用率阈值，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值且只保留整数部分。 **取值范围** **：** \[0,100） | | memory_utilization | Integer | **参数解释** **：** 内存利用率阈值，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值且只保留整数部分。 **取值范围** **：** \[0,100） | | created | String | **参数解释** **：** 创建时间，格式为yyyy-mm-ddThh:mm:ss+0000。 **取值范围** **：** 不涉及。 | | updated | String | **参数解释** **：** 更新时间，格式为yyyy-mm-ddThh:mm:ss+0000。 **取值范围** **：** 不涉及。 | | creator | String | **参数解释** **：** 创建者。 **取值范围** **：** 不涉及。 | | modifier | String | **参数解释** **：** 更新者。 **取值范围** **：** 不涉及。 | | node_infos | Array of objects | **参数解释** **：** CN节点信息列表，详情请参见[表6]。 | 表6ShowLimitTaskNodeOption | 参数 | 参数类型 | 描述 | |:---|:---|:---| | node_id | String | **参数解释** **：** 节点ID。 **取值范围** **：** 不涉及。 | | sql_id | String | **参数解释** **：** 该节点执行的SQL语句ID。 **取值范围** **：** 不涉及。 | #### 请求示例 ``` https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task-list?offset=1&limit=10&limit_type=SQL_ID&task_name=test ``` #### 响应示例 ``` { "limit_task_list" : [ { "task_id" : "59b6a1a278844ac48119d86512e0000", "task_scope" : "SQL", "limit_type" : "SQL_ID", "limit_type_value" : 2348983611, "sql_model" : "select * from table where id = {id}", "status" : "creating", "key_words" : null, "instance_id" : "39b6a1a278844ac48119d86512e0000bin06", "parallel_size" : 100, "rule_name" : "dsa48119d86512e0000bin066a1a27", "databases" : "test1", "task_name" : "test1", "start_time" : "2023-12-30T02:00:00Z", "end_time" : "2023-12-30T02:00:00Z", "created" : "2023-12-28T01:55:08Z,", "updated" : "2023-12-28T01:55:08Z,", "creator" : "test,", "modifier" : "null,", "cpu_utilization" : null, "memory_utilization" : null, "node_infos" : [ { "node_id" : "cf521ccca2d74c9e89569a9828b6adcbno14", "sql_id" : 2348983611 } ] } ], "total_count" : 1, "limit" : 10, "offset" : 1 } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。