# 查询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=ShowLimitTask)中调试该接口。 #### URI GET /v3/{project_id}/instances/{instance_id}/limit-task/{task_id} 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | task_id | 是 | **参数解释：** 限流任务ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | **参数解释：** 实例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_name | String | **参数解释：** 限流任务名。 **取值范围：** 不涉及。 | | limit_type | String | **参数解释：** 任务限流类型。 **取值范围：** - SQL_ID：模板的SQL_ID。 - SQL_TYPE：SQL类型。 - SESSION_ACTIVE_MAX_COUNT：利用率阈值。 | | parallel_size | Integer | **参数解释：** 并发数。 **取值范围：** \[0, 2147483647\] | | start_time | String | **参数解释：** 限流任务开始时间，格式为yyyy-mm-ddThh:mm:ss+0000，当前时间指UTC时间。 **取值范围：** 不涉及。 | | end_time | String | **参数解释：** 限流任务结束时间，格式为yyyy-mm-ddThh:mm:ss+0000，当前时间指UTC时间。 **取值范围：** 不涉及。 | | limit_count | Integer | **参数解释：** 限流次数。 **取值范围：** 不涉及。 | | task_running_time | Integer | **参数解释：** 限流任务运行时长。 **取值范围：** 不涉及。 | | memory_utilization | Integer | **参数解释：** 内存利用率，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值。 **取值范围：** \[0,100） | | cpu_utilization | Integer | **参数解释：** CPU利用率，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值。 **取值范围：** \[0,100） | | rule_name | String | **参数解释：** 规则名。 **取值范围：** 不涉及。 | | limit_task_rule_info_list | Array of objects | **参数解释：** 限流任务节点列表，详情请参见表 [表4]。 | 表4LimitTaskRuleInfoList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | node_id | String | **参数解释** **：** 节点ID。 **取值范围：** 不涉及。 | | rule_id | String | **参数解释** **：** 限流任务ID。 **取值范围：** 不涉及。 | | status | String | **参数解释** **：** 限流任务状态。 **取值范围：** - CREATING：表示正在创建。 - UPDATING：表示正在更新数据。 - DELETING：表示正在删除数据。 - WAIT_EXECUTE：表示操作处于等待执行状态。 - EXECUTING：表示操作正在执行中。 - TIME_OVER：表示操作超时。 - DELETED：表示对象已被删除。 - CREATE_FAILED：表示创建操作失败。 - UPDATE_FAILED：表示更新操作失败。 - DELETE_FAILED：表示删除操作失败。 - EXCEPTION：表示操作过程中发生了异常或错误。 - NODE_SHUT_DOWN：表示节点已关闭。 当前支持：CREATING，UPDATING，DELETING，WAIT_EXECUTE，EXECUTING，TIME_OVER，DELETED，CREATE_FAILED，UPDATE_FAILED，DELETE_FAILED，EXCEPTION，NODE_SHUT_DOWN。 | #### 请求示例 ``` https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task/96854ba7-8d50-4a3c-8fd8-210a7390e9d1 ``` #### 响应示例 - 限流类型是SQL_ID的限流任务。 ``` { "task_name": "123", "limit_type": "SQL_ID", "parallel_size": 0, "start_time": "2024-08-19T07:12:31Z", "end_time": "2024-09-30T07:10:59Z", "limit_count": 1, "task_running_time": 16258, "rule_name": "bca08a79-8557-42c2-ab73-09a14d178c57", "limit_task_rule_info_list": [ { "node_id": "e37a7df4ec694a3cbfeae1aee583d70fno14", "rule_id": "2", "status": "EXCUTING" } ] } ``` - 限流类型是SQL_TYPE的限流任务。 ``` { "task_name": "123", "limit_type": "SQL_TYPE", "parallel_size": 0, "start_time": "2024-08-20T06:54:42Z", "end_time": "2024-09-09T06:53:43Z", "limit_count": 0, "task_running_time": 0, "rule_name": "476faedc-0583-4327-9f48-91fa1703e910", "limit_task_rule_info_list": [ { "node_id": "e37a7df4ec694a3cbfeae1aee583d70fno14", "rule_id": "1", "status": "WAIT_EXCUTE" } ] } ``` - 限流类型是SESSION_ACTIVE_MAX_COUNT的限流任务。 ``` { "task_name": "89", "limit_type": "SESSION_ACTIVE_MAX_COUNT", "parallel_size": 0, "limit_count": 0, "task_running_time": 16283, "memory_utilization": 1, "cpu_utilization": 0, "rule_name": "37b6232c-58ea-4d62-a5b5-54fc215c2115", "limit_task_rule_info_list": [ { "node_id": "e37a7df4ec694a3cbfeae1aee583d70fno14", "rule_id": "3", "status": "EXCUTING" } ] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。