Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Intelligent O&M/ Diagnosing SQL Statements
Updated on 2025-05-19 GMT+08:00
View PDF
Share

Diagnosing SQL Statements

Function

This API is used to diagnose SQL statements.

URI

POST /v3/{project_id}/connections/{connection_id}/tuning/create-tuning

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

connection_id

Yes

String

Explanation:

Database user ID, that is, ID of a connection established between the database account and the database. A database user ID is created by calling the API in Registering a Database User.

Values:

The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

database_name

Yes

String

Explanation:

Database name

Constraints:

Only MySQL databases are supported.

Values:

N/A

Default value:

N/A

schema_name

No

String

Explanation:

Schema name

Constraints:

Only MySQL databases are supported.

Values:

N/A

Default value:

N/A

sql_script

Yes

String

Explanation:

SQL script

Constraints:

N/A

Values:

N/A

Default value:

N/A

node_type

No

String

Explanation:

Node ID

Constraints:

N/A

Values:

N/A

Default value:

N/A

node_id

No

String

Explanation:

Node ID

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

message_id

Array of strings

Explanation:

Diagnosis information ID

Values:

N/A

status

Boolean

Explanation:

Status

Values:

N/A

quota_exceeded

Boolean

Explanation:

Diagnosis quota status

Values:

N/A

Example Request

Diagnosing SQL statements

POST https://{{endpoint}}/v3/{{project_id}}/connections/{connection_id}/tuning/create-tuning 
 
{ 
  "database_name" : "string", 
  "schema_name" : "string", 
  "sql_script" : "string" 
}

Example Responses

{
	"message_id": [
		"6507f5070cf2476b18473d9b"
	],
	"status": true,
	"quota_exceeded": false
}

Status Code

Status Code

Description

200

Successful request

400

Bad request

500

Internal server error

Error Code

See Error Codes.

Parent topic: Intelligent O&M