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

Adding a SQL Throttling Rule for a Database

Function

This API is used to add a SQL throttling rule for a database.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/sql-limit

  • Parameter description
    Table 1 Parameters

    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

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

db_name

Yes

String

Definition

Database name.

Constraints

N/A

Range

N/A

Default Value

N/A

query_id

No

Long

Definition

Internal hash code calculated by the SQL parse tree.

Constraints

N/A

Range

-9223372036854775808~ 9223372036854775807

Default Value

0

query_string

No

String

Definition

Text format of an SQL statement.

Constraints

Only either query_id or query_string can be specified.

Range

N/A

Default Value

N/A

max_concurrency

Yes

Integer

Definition

Number of SQL statements that can be executed at the same time.

Constraints

N/A

Range

-1–50000. If the value is less than or equal to 0, the number is not limited.

Default Value

0

max_waiting

Yes

Integer

Definition

Maximum waiting time, in seconds.

Constraints

N/A

Range

N/A

Default Value

N/A

search_path

No

String

Definition

Schema search order set for names that are not schema-qualified.

Constraints

N/A

Range

N/A

Default Value

public

Example Request

Add a SQL throttling rule for a database.

POST https://rds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/sql-limit

{ 
   "db_name" : "postgres", 
   "query_id" : 1, 
   "max_concurrency" : 10, 
   "max_waiting" : 10, 
   "search_path" : "public" 
 }

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    resp

    String

    Definition

    Calling result.

    Range

    Returns successful if the calling is successful.

Status Code

Error Code

For details, see Error Codes.