使用此API创建可编程对象变更工单。
接口说明
仅管控模式为安全协同的数据库实例可调用此 API。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dms:CreateProcCorrectOrder | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Comment | string | 是 | 工单备注。 | test |
RelatedUserList | array | 否 | 工单相关人列表。 | |
long | 否 | 工单相关人 ID。 | 1342** | |
Param | object | 是 | 工单参数。 | |
Classify | string | 否 | 变更原因。 | test |
DbItemList | array<object> | 是 | 数据库信息。 | |
object | 否 | 数据库信息。 | ||
DbId | long | 是 | 数据库 ID(DatabaseId)。数据库分为物理库和逻辑库两种:
| 1972**** |
Logic | boolean | 是 | 是否为逻辑库,取值如下:
| false |
RollbackSQL | string | 否 | 回滚 SQL 语句。 说明
如果 RollbackSqlType 为 TEXT,该参数必填。
| empty |
RollbackAttachmentName | string | 否 | 回滚 SQL 附件 Key(AttachmentKey),可通过调用 GetUserUploadFileJob 接口获取该参数的值。 说明
如果 RollbackSqlType 为 ATTACHMENT,该参数必填。
| test_rollback.sql |
RollbackSqlType | string | 否 | 回滚 SQL 的提交方式,取值如下:
| TEXT |
ExecSQL | string | 是 | 变更 SQL 语句。 | DELIMITER /// CREATE PROCEDURE GetAllProducts() BEGIN SELECT * FROM base_user; END /// |
ExecMode | string | 否 | 工单执行方式,取值如下:
| COMMITOR |
AttachmentKey | string | 否 | 工单补充附件,对本次操作进行补充说明。 您可以调用 GetUserUploadFileJob 接口获取该参数。 | order_attachment.txt |
Tid | long | 否 | 租户 ID。 说明
取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息。
| 4*** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
"Success": true,
"ErrorMessage": "UnknownError",
"ErrorCode": "UnknownError",
"CreateOrderResult": [
0
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-12-06 | API 内部配置变更,不影响调用 | 查看变更详情 |