更新时间:2024-11-01 GMT+08:00
分享

查询SQL限流任务详情

功能介绍

根据指定条件查询限流任务列表。

调试

您可以在API Explorer中调试该接口。

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/limit-task-list/{task_id}

表1 参数说明

名称

是否必选

说明

project_id

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

task_id

限流任务ID。

instance_id

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

语言。

缺省值:en-us

枚举值:

  • zh-cn
  • en-us

响应参数

表3 响应Body参数

参数

参数类型

描述

task_name

String

限流任务名。

limit_type

String

任务限流类型。

parallel_size

Integer

并发数。

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时,返回该值。

cpu_utilization

Integer

CPU利用率,仅当任务类型为SESSION_ACTIVE_MAX_COUNT时,返回该值。

rule_name

String

规则名。

limit_task_rule_info_list

Array of objects

限流任务节点列表,详情请参见表 表4

表4 LimitTaskRuleInfoList

参数

参数类型

描述

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。

请求示例

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"
            }
        ]
    }

状态码

错误码

请参见错误码

相关文档