Updated on 2026-08-25 GMT+08:00

Formatting SQL Statements

Function

This API is used to format SQL statements.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

das:connection:list

list

connection

-

das:connections:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
das:connection:list	list	connection	-	das:connections:list	-

URI

POST /v3/{project_id}/connections/{connection_id}/format-sql

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are supported. Default Value N/A
connection_id	Yes	String	Definition Connection ID established between a database account and the database. The database user ID is created using the API in Creating an Instance Connection. Constraints N/A Range The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
sql_script	Yes	String	Definition SQL statement to be formatted Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
format_sql	String	Definition Formatted SQL statement Range N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/format-sql
 
{ 
 "sql_script": "select * from test;" 
}

Example Responses

Status code: 200

Success.

{"format_sql":"SELECT *\nFROM test;"}

Status Codes

Status Code	Description
200	Success.
400	Client error.
500	Server error.

Error Codes

See Error Codes.

Parent topic: Intelligent O&M