Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Intelligent O&M/ Executing a SQL Diagnosis Task
Updated on 2026-01-20 GMT+08:00
View PDF
Share

Executing a SQL Diagnosis Task

Function

This API is used to execute a SQL diagnosis task.

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:clouddba:sqlDiagnosis

    Write

    Connection

    Instance

    -

    -

    -

URI

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

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, including only letters and digits.

Default Value

N/A

connection_id

Yes

String

Definition

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 Creating a Database User.

Range

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

Definition

Database name

Constraints

Only MySQL databases are supported.

Range

N/A

Default Value

N/A

schema_name

No

String

Definition

Schema name

Constraints

Only MySQL databases are supported.

Range

N/A

Default Value

N/A

sql_script

Yes

String

Definition

SQL script

Constraints

N/A

Range

N/A

Default Value

N/A

node_type

No

String

Definition

Node type

Constraints

N/A

Range

  • master: primary node
  • slave: secondary node
  • readreplica: read replica

Default Value

N/A

node_id

No

String

Definition

Node ID

Constraints

N/A

Range

The value can contain 32 characters, including only letters and digits.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

message_id

Array of strings

Definition

Diagnosis information ID

Range

N/A

status

Boolean

Definition

Status

Range

  • true: The task is created.
  • false: The task failed to be created.

quota_exceeded

Boolean

Definition

Diagnosis quota status

Range

N/A

Example Requests

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 Codes

Status Code

Description

200

Successful response

400

Bad request

500

Internal server error

Error Codes

See Error Codes.

Parent topic: Intelligent O&M