创建数据导入工单。
接口说明
关于该功能的更多说明,请参见数据导入。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dms:CreateDataImportOrder | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Comment | string | 是 | 数据导入的业务背景,以减少沟通成本。 | test |
RelatedUserList | array | 否 | 相关人列表。 | |
long | 否 | 变更相关人的用户ID,设置的相关人员可查看工单,并协同工作,非相关人员则不能查看工单(管理员、DBA除外)。 | 51**** | |
Param | object | 是 | 工单参数。 | |
Classify | string | 否 | 数据导入原因。 | test |
AttachmentName | string | 是 | 导入数据的附件Key(AttachmentKey),可通过调用接口GetUserUploadFileJob获取该参数的值。 | order_text |
DbItemList | object [] | 是 | 待导入的数据库列表,当前仅支持导入一个库。 | |
DbId | long | 是 | 数据库ID(DatabaseId),数据库分为物理库和逻辑库两种:
| 1860**** |
Logic | boolean | 是 | 是否为逻辑库,取值如下:
说明如果取值为true,目标数据库必须为逻辑库。 | false |
FileType | string | 是 | 文件类型,取值如下:
| CSV |
FileEncoding | string | 否 | 文件编码,取值如下:
| AUTO |
TableName | string | 否 | 选择CSV格式文件导入数据的目标表。 说明如果FileType为CSV,该参数必填。 | Table_text |
InsertType | string | 否 | 插入类型,取值如下:
说明如果FileType为CSV,该参数必填。 | INSERT |
CsvFirstRowIsColumnDef | boolean | 否 | CSV格式的类型,取值如下:
说明如果FileType为CSV,该参数必填。 | true |
IgnoreError | boolean | 否 | 是否忽略报错,取值如下:
| false |
ImportMode | string | 否 | 导入模式,取值如下:
| FAST_MODE |
RollbackSQL | string | 否 | 回滚SQL语句。 说明如果RollbackSqlType为TEXT,该参数必填。 | empty |
RollbackAttachmentName | string | 否 | 回滚SQL附件Key(AttachmentKey),可通过调用接口GetUserUploadFileJob获取该参数的值。 说明如果RollbackSqlType为ATTACHMENT,该参数必填。 | rollback.sql |
RollbackSqlType | string | 否 | 回滚SQL的提交方式,取值如下:
| TEXT |
AttachmentKey | string | 否 | 工单附件Key,补充当前工单信息。可通过调用接口GetUserUploadFileJob获取该参数的值。 | order_attachment.txt |
Tid | long | 否 | 租户ID,可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。 | 3*** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"Success": true,
"ErrorMessage": "UnknownError",
"ErrorCode": "UnknownError",
"CreateOrderResult": [
0
]
}
错误码
访问错误中心查看更多错误码。