调用CreateSQLReviewOrder创建SQL审核工单。

关于该功能的更多说明,请参见SQL审核

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateSQLReviewOrder

系统规定的参数。取值:CreateSQLReviewOrder

Comment String test

业务背景,描述任务的原因或目标,以减少沟通成本。

RelatedUserList Array of Long 123443

相关人ID。

Param Object

工单参数。

ProjectName String xxx业务SQL审核

项目名称。

DbId Long 123321

数据库ID,可调用SearchDatabases接口获取。

说明 当前仅支持物理库,暂不支持逻辑库。
AttachmentKeyList Array of String upload_xxxx.sql

附件Key,支持添加多个附件,您可以调用GetUserUploadFileJob接口获取该参数。

说明 仅支持iBatis框架或MyBatis框架的.xml文件与.txt格式的SQL文件。
Tid Long 1

租户ID。您可以调用GetUserActiveTenantListUserTenants接口获取该参数。

RegionId String cn-hangzhou

选择DMS的服务地域。用于调用该接口,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
RequestId String 0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String 200

错误码。

CreateOrderResult Array of Long 1423532

工单号。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateSQLReviewOrder
&Comment=test
&RelatedUserList=[123443]
&Param={"ProjectName":"xxx业务SQL审核","DbId":123321,"AttachmentKeyList":["upload_xxxx.sql"]}
&Tid=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateSQLReviewOrderResponse>
    <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>
    <Success>true</Success>
    <ErrorMessage>UnknownError</ErrorMessage>
    <ErrorCode>UnknownError</ErrorCode>
    <CreateOrderResult>1423532</CreateOrderResult>
</CreateSQLReviewOrderResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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