文档首页/ 数据管理服务 DAS/ API参考/ API(公测中)/ 云DBA/ 创建SQL诊断任务 - ExeTuning
更新时间:2025-12-04 GMT+08:00
分享

创建SQL诊断任务 - ExeTuning

功能介绍

创建SQL诊断任务。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    das:clouddba:sqlDiagnosis

    write

    instance

    -

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

connection_id

String

参数解释:

连接ID。用户使用数据库账号与数据库建立的连接ID(数据库用户ID由创建实例连接接口创建)。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字、中划线组成,且长度为36个字符的UUID。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

database_name

String

参数解释:

数据库名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

schema_name

String

参数解释:

schema名称。

约束限制:

诊断实例类型为postgresql时可用。

取值范围:

不涉及。

默认取值:

不涉及。

sql_script

String

参数解释:

诊断的SQL语句。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

node_type

String

参数解释:

执行节点类型。

约束限制:

不涉及。

取值范围:

  • master:主节点
  • slave:副节点
  • readreplica:只读节点

默认取值:

不涉及。

node_id

String

参数解释:

执行节点ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

use_default_search_path

Boolean

参数解释:

是否使用searth_path作为环境变量。

约束限制:

诊断实例类型为postgresql时可用。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

message_id

Array of Strings

参数解释:

SQL诊断消息ID列表。

取值范围:

不涉及。

status

Boolean

参数解释:

诊断任务创建状态。

取值范围:

不涉及。

quota_exceeded

Boolean

参数解释:

是否超过诊断任务创建限额。

取值范围:

不涉及。

请求示例

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
}

响应示例

状态码: 200

Success.

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

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档