CreateSQLReviewOrder - Data Management - Alibaba Cloud Documentation Center

Creates a SQL review ticket.

Operation description

You can call this operation only for database instances that are managed in Security Collaboration mode.

For more information about the SQL review feature, see SQL review.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:CreateSQLReviewOrder	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Comment	string	Yes	The purpose or objective of the SQL review. This reduces unnecessary communication.	test
RelatedUserList	array	No	The stakeholders involved in this operation. All the specified stakeholders can view the ticket details and take part in the approval process. Irrelevant users other than DMS administrators and database administrators (DBAs) are not allowed to view the ticket details.
	long	No	The IDs of the stakeholders.	123443
Param	object	Yes	The parameters of the ticket.
ProjectName	string	Yes	The name of the project.	SQL review for xxx
DbId	long	Yes	The ID of the database. You can call the SearchDatabases operation to query the ID of the database. Note You can call this operation to query only physical databases. This operation is unavailable to query logical databases.	123321
AttachmentKeyList	array	Yes	The files to be reviewed. Multiple files can be reviewed at a time.
	string	No	The key of the file. You can add multiple keys. To obtain the key of a file, call the GetUserUploadFileJob operation. Note Only XML files based on the iBatis or MyBatis framework or TXT files are supported.	upload_xxxx.sql
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	Indicates whether the request was successful.	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	200
CreateOrderResult	array	The result of the ticket creation task.
	long	The ID of the ticket.	1423532

Examples

Sample success responses

JSONformat

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "200",
  "CreateOrderResult": [
    1423532
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history