Checking SQL Syntax

Function

This API is used to check the SQL syntax.

Authorization

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

• If you are using role/policy-based authorization, see the required permissions in Introduction.
• 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	Dependency
  dli::checkSql	write	-	-	-	-

URI

• URI format

  POST /v1.0/{project_id}/jobs/check-sql

• Parameter descriptions

  Table 1 URI parameter

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

Request Parameters

Response Parameters

Example Request

Check the syntax of the SQL statement select * from t1.

{
   "currentdb": "db1",
   "sql": "select * from t1"   
}

Example Response

{
  "is_success": true,
  "message": "the sql is ok",
  "job_type":"QUERY"
}

Status Codes

Table 4 describes status codes.

Error Codes

If an error occurs when this API is called, the system does not return the result similar to the preceding example, but returns an error code and error message. For details, see Error Codes.