# 根据指定条件查询SQL限流任务列表（v3.1） - QueryingSQLThrottlingTasksBasedonSpecifiedCriteria #### 功能介绍 根据指定条件查询限流任务列表。 - 调用接口前，您需要了解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=ListSqlLimitTask)中调试该接口。 #### URI POST /v3.1/{project_id}/instances/{instance_id}/limit-task-list 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | #### 请求参数 表2请求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** | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_scope | 否 | String | **参数解释** **：** 限流任务范围。 **约束限制** **：** 不涉及。 **取值范围** **：** - SQL：SQL语句范围。 - SESSION：Session会话范围。 **默认取值** **：** 不涉及。 | | limit_type | 否 | String | **参数解释** **：** 限流类型。 **约束限制** **：** 不涉及。 **取值范围** **：** - SQL_ID：SQL语句ID。 - SQL_TYPE：SQL语句类型。 - SESSION_ACTIVE_MAX_COUNT：会话最大活动数。 **默认取值** **：** 不涉及。 | | limit_type_value | 否 | String | **参数解释** **：** 限流类型值，支持模糊匹配。 **约束限制** **：** 不涉及。 **取值范围** **：** 长度为1\~19字符，且只能包含大小写字母、数字和_。 **默认取值** **：** 不涉及。 | | task_name | 否 | String | **参数解释** **：** 限流任务名，支持模糊匹配。 **约束限制** **：** 不涉及。 **取值范围** **：** 长度为1\~100字符，只能包含大小写字母、数字、-、_和$。 **默认取值** **：** 不涉及。 | | rule_name | 否 | String | **参数解释** **：** 规则名。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | offset | 是 | Integer | **参数解释** **：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制** **：** 不涉及。 **取值范围** **：** 0 - 10000 **默认取值** **：** 0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 是 | Integer | **参数解释** **：** 查询记录数。 **约束限制** **：** 不涉及。 **取值范围** **：** 不能为负数，最小值为1，最大值为100。 **默认取值** **：** 10 | | sql_id | 否 | String | **参数解释** **：** 限流任务SQL_ID。获取方式请参考[查询全量单条SQL列表 - QueryingFullDatabySQLStatement](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_541.html)。 **约束限制** **：** 不涉及。 **取值范围** **：** 1 到 19 位的正整数（首位不为 0）。 **默认取值** **：** 不涉及。 | | node_ids | 否 | Array of String | **参数解释** **：** 限流任务NodeID列表。获取方式请参考[查询实例的组件列表 - QueryingtheComponentsofaDBInstance](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_028.html)。 **约束限制** **：** 不涉及。 | #### 响应参数 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | limit_task_list | Array of objects | **参数解释** **：** 限流任务列表。详情请参见[表5 ListLimitTaskResponseResult]。 | | limit | Integer | **参数解释** **：** 查询记录数。 **取值范围** **：** 不涉及。 | | offset | Integer | **参数解释** **：** 索引位置。 **取值范围** **：** 不涉及。 | | total_count | Integer | **参数解释** **：** 限流任务列表总数，单位：个。 **取值范围** **：** 不涉及。 | 表5ListLimitTaskResponseResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | **参数解释** **：** 限流任务ID。 **取值范围** **：** 不涉及。 | | task_scope | String | **参数解释** **：** 任务限流范围。 **取值范围** **：** - SQL：SQL语句范围。 - SESSION：Session会话范围。 | | limit_type | String | **参数解释**： 任务限流类型。 **取值范围** **：** - SQL_ID：SQL语句ID。 - SQL_TYPE：SQL语句类型。 - SESSION_ACTIVE_MAX_COUNT：会话最大活动数。 | | limit_type_value | String | **参数解释** **：** 任务限流类型值。 **取值范围** **：** 不涉及。 | | task_name | String | **参数解释** **：** 限流任务名。 **取值范围** **：** 不涉及。 | | databases | String | **参数解释** **：** CN节点数据库组，每个数据库字符串以逗号形式隔开。 **取值范围** **：** 不涉及。 | | key_words | String | **参数解释** **：** 关键词。 **取值范围** **：** 不涉及。 | | status | String | **参数解释** **：** 限流任务状态。 **取值范围** **：** - CREATING：创建中。 - UPDATING：更新中。 - DELETING：删除中。 - WAIT_EXECUTE：等待执行。 - EXCUTING：执行中。 - TIME_OVER：超时。 - DELETED：删除。 - CREATE_FAILED：创建失败。 - UPDATE_FAILED：更新失败。 - DELETE_FAILED：删除失败。 - EXCEPTION：异常。 - NODE_SHUT_DOWN：节点关闭。 | | instance_id | String | **参数解释** **：** 实例ID。 **取值范围** **：** 不涉及。 | | rule_name | String | **参数解释** **：** 规则名。 **取值范围** **：** 不涉及。 | | parallel_size | Integer | **参数解释** **：** 并发数，单位：条。 **取值范围** **：** 不涉及。 | | start_time | String | **参数解释** **：** 限流任务开始时间。 **取值范围** **：** 格式为yyyy-mm-ddThh:mm:ssZ，当前时间指UTC时间。 | | end_time | String | **参数解释** **：** 限流任务结束时间。 **取值范围** **：** 格式为yyyy-mm-ddThh:mm:ssZ，当前时间指UTC时间。 | | cpu_utilization | Integer | **参数解释** **：** CPU利用率，单位：%。仅当limit_type值为SESSION_ACTIVE_MAX_COUNT时有值。 **取值范围** **：** 不涉及。 | | memory_utilization | Integer | **参数解释** **：** 内存利用率，单位：%。仅当limit_type值为SESSION_ACTIVE_MAX_COUNT时有值。 **取值范围** **：** 不涉及。 | #### 请求示例 根据指定条件查询限流任务列表。 ``` POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task-list { "limit_type" : "SQL_ID", "offset" : 1, "limit" : 10, "node_ids" : [ "cf521ccca2d74c9e89569a9828b6adcbno14" ] } ``` #### 响应示例 ``` { "limit_task_list" : [ { "task_id" : "59b6a1a278844ac48119d86512e0000", "task_scope" : "SQL", "limit_type" : "SQL_ID", "limit_type_value":"SQL", "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", "cpu_utilization" : null, "memory_utilization" : null } ], "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)。