All Products
Search
Document Center

Data Management:CreateSQLReviewOrder

Last Updated:Oct 21, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CommentstringYes

The purpose or objective of the SQL review. This reduces unnecessary communication.

test
RelatedUserListarrayNo

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.

longNo

The IDs of the stakeholders.

123443
ParamobjectYes

The parameters of the ticket.

ProjectNamestringYes

The name of the project.

SQL review for xxx
DbIdlongYes

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
AttachmentKeyListarrayYes

The files to be reviewed. Multiple files can be reviewed at a time.

stringNo

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
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Successboolean

Indicates whether the request was successful.

true
ErrorMessagestring

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code returned if the request failed.

200
CreateOrderResultarray

The result of the ticket creation task.

OrderIdslong

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 timeSummary of changesOperation
No change history