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

Updated on 2025-10-20 GMT+08:00

View PDF

Querying SQL Throttling Task Details (v3.1)

Function

This API is used to query throttling task details. Before calling this API:

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

Debugging

You can debug this API in API Explorer.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	Definition Throttling task ID. Constraints N/A Range N/A Default Value N/A
project_id	Yes	String	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
instance_id	Yes	String	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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
node_id	Yes	String	Definition Node ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** 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. The value of X-Subject-Token in the response 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 4** Response body parameters
Parameter	Type	Description
limit_count	Integer	Definition Connections blocked by the throttling task. Range N/A

Example Request

Querying throttling task details

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/4f07d3f50ce2466a9a7c014337b36409/instances/7912cd1077b2413fbd6f39a044777537in14/limit-task/96854ba7-8d50-4a3c-8fd8-210a7390e9d1?node_id=46d996fdda594f58b17fe509061e0893no14