Querying SQL Templates

Function

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

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

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the value, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
instance_id	Yes	String	Instance ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
node_id	Yes	String	Node ID.
sql_model	No	String	SQL template. The value can contain only uppercase letters, lowercase letters, underscores (_), digits, spaces, and the following special characters $*?=+;()><,."
offset	No	Integer	Index offset. If offset is set to N, the resource query starts from the N+1 data entry. The default value is 0, indicating that the query starts from the first data entry. The value cannot be a negative number. Value range: 0 to 10000
limit	No	Integer	Number of records to be queried. The default value is 10. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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.
X-Language	No	String	Language. Default value: en-us Value range: zh-cn en-us

Response Parameters

**Table 4** Response body parameters
Parameter	Type	Description
node_limit_sql_model_list	Array of objects	Information about the SQL template for SQL throttling. For details, see Table 5.
limit	Integer	Number of records to be queried.
offset	Integer	Index offset.
total_count	Integer	Total number of SQL templates.

**Table 5** ListNodeLimitSqlModelResponseResult
Parameter	Type	Description
sql_id	String	SQL ID of the throttling task.
sql_model	String	SQL template of the throttling task.

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
}