调用CreateSQLReviewOrder创建SQL审核工单。
接口说明
仅管控模式为安全协同的数据库实例可调用此 API。
关于该功能的更多说明,请参见 SQL 审核。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dms:CreateSQLReviewOrder | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Comment | string | 是 | 业务背景,描述任务的原因或目标,以减少沟通成本。 | test |
RelatedUserList | array | 否 | 相关人列表。设置的相关人可查看工单,并协同工作,非相关人员不能查看工单(管理员、DBA 除外)。 | |
long | 否 | 相关人 ID。 | 123443 | |
Param | object | 是 | 工单参数。 | |
ProjectName | string | 是 | 项目名称。 | xxx业务SQL审核 |
DbId | long | 是 | 数据库 ID,可调用 SearchDatabases 接口获取。 说明
当前仅支持物理库,暂不支持逻辑库。
| 123321 |
AttachmentKeyList | array | 是 | SQL 审核文件列表。审核的内容支持多个文件。 | |
string | 否 | 附件 Key,支持添加多个附件,您可以调用 GetUserUploadFileJob 接口获取该参数。 说明
仅支持 iBatis 框架或 MyBatis 框架的.xml 文件与.txt 格式的 SQL 文件。
| upload_xxxx.sql | |
Tid | long | 否 | 租户 ID。您可以调用 GetUserActiveTenant 或 ListUserTenants 接口获取该参数。 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"Success": true,
"ErrorMessage": "UnknownError",
"ErrorCode": "200",
"CreateOrderResult": [
1423532
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史