Use CreateRequestDiagnosis to initiate SQL statement diagnosis - Database Autonomy Service

Operation description

Before you call this operation, take note of the following items:

If you use an SDK to call Database Autonomy Service (DAS), you must set the region to cn-shanghai.
This operation supports the following database engines:
- ApsaraDB RDS for MySQL
- ApsaraDB RDS for PostgreSQL
- ApsaraDB RDS for SQL Server
- PolarDB for MySQL
- PolarDB for PostgreSQL (compatible with Oracle)
- ApsaraDB for MongoDB

Note

The minor engine version of ApsaraDB RDS for PostgreSQL instances must be 20221230 or later. For more information about how to check and update the minor engine version of an ApsaraDB RDS for PostgreSQL instance, see Update the minor engine version of an ApsaraDB RDS for PostgreSQL instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:CreateRequestDiagnosis

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	rm-0iwhhl8gx0ld6****
NodeId	string	No	The node ID. Note This parameter must be specified for PolarDB for MySQL, PolarDB for PostgreSQL (Compatible with Oracle), and ApsaraDB for MongoDB instances.	202****
Database	string	Yes	The name of the database.	das
Sql	string	Yes	The SQL statement that you want to diagnose.	select * from test where name = 'mockUser'

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code returned.	200
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
Data	string	The diagnostics ID, which is the unique identifier of the diagnosis. This parameter can be used to query the result of the diagnosis.	61820b594664275c4429****
RequestId	string	The request ID.	800FBAF5-A539-5B97-A09E-C63AB2F7****
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.