Help Center/ Data Admin Service/ API Reference/ APIs/ Intelligent O&M/ Creating a SQL Diagnosis Task
Updated on 2026-08-25 GMT+08:00

Creating a SQL Diagnosis Task

Function

This API is used to create 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

    Instance

    -

    -

    -

URI

POST /v3/{project_id}/connections/{connection_id}/tuning/exe-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. 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

database_name

Yes

String

Definition

Database name

Constraints

N/A

Range

N/A

Default Value

N/A

schema_name

No

String

Definition

Schema name

Constraints

This parameter is available when the diagnosis instance type is PostgreSQL.

Range

N/A

Default Value

N/A

sql_script

Yes

String

Definition

SQL statement to be diagnosed

Constraints

N/A

Range

N/A

Default Value

N/A

node_type

No

String

Definition

Execution node type

Constraints

N/A

Range

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

Default Value

N/A

node_id

No

String

Definition

Execution node ID

Constraints

N/A

Range

N/A

Default Value

N/A

use_default_search_path

No

Boolean

Definition

Whether to use search_path as an environment variable

Constraints

This parameter is available when the diagnosis instance type is PostgreSQL.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

message_id

Array of Strings

Definition

SQL diagnosis message ID list

Range

N/A

status

Boolean

Definition

Creation status of a diagnosis task

Range

N/A

quota_exceeded

Boolean

Definition

Whether the number of created diagnosis tasks exceeds the upper limit

Range

N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/tuning/exe-tuning 
 
{
  "database_name": "czh_test",
  "node_id": "7c1efa30d2a340b68bc0a80652e14179no01",
  "node_type": "master",
  "sql_script": "SELECT * FROM lbw",
  "use_default_search_path": false
}

Example Responses

Status code: 200

Success.

{
  "message_id": ["692d85960cf263510807db3c"],
  "status": true,
  "quota_exceeded": false
}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.