Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ SQL Throttling/ Querying SQL Throttling Task Details

Updated on 2025-08-11 GMT+08:00

View PDF

Querying SQL Throttling Task Details

Function

This API is used to query SQL throttling task details based on search criteria. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/instances/{instance_id}/limit-task/{task_id}

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
task_id	Yes	Definition Throttling task ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
task_name	String	Definition Throttling task name. Range N/A
limit_type	String	Definition Throttling task type. Range If task_scope is set to SQL, this parameter value can be SQL_ID or SQL_TYPE. If task_scope is set to SESSION, this parameter value can be SESSION_ACTIVE_MAX_COUNT.
parallel_size	Integer	Definition Maximum concurrency. Range [0, 2147483647]
start_time	String	Definition Start time of the throttling task in the format of yyyy-mm-ddThh:mm:ss+0000 (UTC time). Range N/A
end_time	String	Definition End time of the throttling task in the format of yyyy-mm-ddThh:mm:ss+0000 (UTC time). Range N/A
limit_count	Integer	Definition Throttling times. Range N/A
task_running_time	Integer	Definition Running duration of a throttling task. Range N/A
memory_utilization	Integer	Definition Memory usage. This parameter is returned only when the task type is SESSION_ACTIVE_MAX_COUNT. Range [0,100)
cpu_utilization	Integer	Definition CPU usage. This parameter is returned only when the task type is SESSION_ACTIVE_MAX_COUNT. Range [0,100)
rule_name	String	Definition Rule name. Range N/A
limit_task_rule_info_list	Array of objects	Definition Nodes of throttling tasks. For details, see Table 4.

**Table 4** LimitTaskRuleInfoList
Parameter	Type	Description
node_id	String	Definition Node ID. Range N/A
rule_id	String	Definition Throttling task ID. Range N/A
status	String	Definition Throttling task status. Range The value can be CREATING, UPDATING, DELETING, WAIT_EXECUTE, EXECUTING, TIME_OVER, DELETED, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED, EXCEPTION, or NODE_SHUT_DOWN.

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task/96854ba7-8d50-4a3c-8fd8-210a7390e9d1

Example Response

Throttling tasks whose type is SQL_ID queried.

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

Throttling tasks whose type is SQL_TYPE queried.

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

Throttling tasks whose type is SESSION_ACTIVE_MAX_COUNT queried.

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