创建工单。
接口说明
为了降低创建工单的难度,如果您需要创建以下类型的工单,请调用专用接口创建。
- 普通数据变更工单:调用 CreateDataCorrectOrder 接口。
- 历史数据清理工单:调用 CreateDataCronClearOrder 接口。
- 数据导入工单:调用 CreateDataImportOrder 接口。
- 无锁变更工单:调用 CreateFreeLockCorrectOrder 接口。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dms:CreateOrder | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Tid | long | 否 | 租户 ID,可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。 | 3*** |
Comment | string | 是 | 输入工单描述信息。 | test |
PluginParam | object | 是 | 创建工单参数,格式为 JSON 形式的字符串。每个工单类型的参数设置不一致,详情请参见表格下方的PluginParam 参数补充说明。 | {PluginParam_test} |
RelatedUserList | string | 是 | 工单相关人用户 ID 列表,多个相关人用半角逗号(,)隔开。 | user1,user2 |
PluginType | string | 是 | 工单类型,取值请参见 PluginType 参数说明。 | DATA_EXPORT |
AttachmentKey | string | 否 | 上传附件成功后返回的附件 Key,可通过调用接口 GetUserUploadFileJob 获取该参数的值。 | test_AttachmentKey |
PluginParam 参数补充说明
# 结构设计
{
"title": "test", // 标题
"description": "test", // 描述
"dbId": 11****, // 基准库
"logic": false, // 是否逻辑库
"relatedIds": [], // 变更相关人用户 ID
}
# 数据导出
{
"classify": "原因分类", // 原因分类
"dbId": 17****, // 导出库 id
"exeSQL": "select 1", // 导出 SQL
"logic": false, // 是否逻辑库
"ignoreAffectRows": false, // 是否忽略校验影响行数
"affectRows": 1, // 用户预估影响行数
"ignoreAffectRowsReason": "" // 忽略影响行数校验原因
}
如果您需要创建更多类型的工单,请提交工单咨询。
返回参数
示例
正常返回示例
JSON
格式
{
"CreateOrderResult": {
"OrderIds": [
0
]
},
"RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6****",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史