CreateRequestDiagnosis - 发起SQL诊断请求

更新时间:
复制为 MD 格式

调用CreateRequestDiagnosis接口,发起SQL诊断请求。

接口说明

使用该接口需满足以下前提条件:

  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

  • 本接口适用的数据库引擎为:

    • RDS MySQL

    • RDS PostgreSQL

    • RDS SQL Server

    • PolarDB MySQL 版

    • PolarDB PostgreSQL 版(兼容 Oracle)

    • 云数据库 MongoDB 版

说明

RDS PostgreSQL 实例内核小版本为 20221230 及以上。查看和升级内核小版本,请参见升级内核小版本

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:CreateRequestDiagnosis

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

rm-0iwhhl8gx0ld6****

NodeId

string

节点 ID。

说明

对于 PolarDB MySQL 版、PolarDB PostgreSQL 版(兼容 Oracle)和云数据库 MongoDB 等集群实例,需要提供节点 ID。

202****

Database

string

数据库名。

das

Sql

string

待诊断的 SQL。

select * from test where name = 'mockUser'

返回参数

名称

类型

描述

示例值

object

Code

string

返回的状态码。

200

Message

string

请求返回的消息。

说明

请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。

Successful

Data

string

诊断 ID,是诊断的唯一标识,后续用于查询诊断结果。

61820b594664275c4429****

RequestId

string

请求 ID。

800FBAF5-A539-5B97-A09E-C63AB2F7****

Success

string

请求是否执行成功:

  • true:执行成功。

  • false:执行失败。

true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "Data": "61820b594664275c4429****",
  "RequestId": "800FBAF5-A539-5B97-A09E-C63AB2F7****",
  "Success": "true"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParams The request parameters are invalid. 请求参数错误
403 NoPermission You are not authorized to do this action. 没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情