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

Querying SQL Templates

Function

This API is used to query SQL templates of a specified node. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/list-node-limit-sql-model

Table 1 Parameter description

Parameter

Mandatory

Type

Description

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

sql_model

No

String

Definition

SQL template.

Constraints

N/A

Range

The value can contain only uppercase letters, lowercase letters, underscores (_), digits, spaces, and the following special characters $*?=+;()><,."

Default Value

N/A

offset

No

Integer

Definition

Index offset. The query starts from the next piece of data indexed by this parameter.

Constraints

The value must be a non-negative integer.

Range

0 ~10000

Default Value

0: The query starts from the first data record.

limit

No

Integer

Definition

Number of records returned by a query.

Constraints

N/A

Range

1~100

Default Value

10

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.

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 4 Response body parameters

Parameter

Type

Description

node_limit_sql_model_list

Array of objects

Definition

Information about the SQL template for SQL throttling. For details, see Table 5.

limit

Integer

Definition

Number of records returned by a query.

Range

0~100

offset

Integer

Definition

Index offset.

Range

0~10000

total_count

Integer

Definition

Total number of SQL templates.

Range

0~10000

Table 5 ListNodeLimitSqlModelResponseResult

Parameter

Type

Description

sql_id

String

Definition

SQL ID of the throttling task.

Range

N/A

sql_model

String

Definition

SQL template of the throttling task.

Range

N/A

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/list-node-limit-sql-model?node_id=46d996fdda594f58b17fe509061e0893no14&offset=0

Example Response

{
    "node_limit_sql_model_list" : [ {
       "sql_id" : "3519660378",
       "sql_model" : "select * from table where id= ?"
       } ],
    "total_count" : 1,
    "limit" : 10,
    "offset" : 1
}

Status Codes

Error Codes

For details, see Error Codes.