创建SQL结果集导出工单。
接口说明
仅管控模式为安全协同的数据库实例可调用此 API。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dms:CreateDataExportOrder | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ParentId | long | 否 | 父工单 ID。 | 877**** |
| Comment | string | 是 | 业务背景，描述提工单的原因，以减少沟通成本。 | 业务测试。 |
| AttachmentKey | string | 否 | 工单附件 Key，补充当前工单信息。可通过调用接口 GetUserUploadFileJob 获取该参数的值。 | order_attachment.txt |
| RelatedUserList | array | 否 | 相关人列表。 | |
| long | 否 | 变更相关人的用户 ID，非阿里云 UID。设置的相关人员可查看工单，并协同工作，非相关人员则不能查看工单（管理员、DBA 除外）。 | 2452345113**** | |
| PluginParam | object | 是 | 工单参数。 | |
| AffectRows | long | 是 | 预估影响 SQL 行数。 | 1 |
| Classify | string | 是 | 导出工单的原因类别。 | 测试 |
| InstanceId | long | 是 | 实例 ID。 | 132**** |
| DbId | long | 是 | 数据库 ID。 | 18**** |
| Logic | boolean | 是 | 是否为逻辑库，取值如下：
说明
如果取值为 true，目标数据库必须为逻辑库。
| true |
| IgnoreAffectRows | boolean | 是 | 是否跳过 SQL 行数校验，返回值如下：
| true |
| IgnoreAffectRowsReason | string | 否 | 跳过 SQL 行数校验的原因。当您需要跳过行数校验时必须填该参数。 | 仅测试，不影响业务，无需校验。 |
| ExeSQL | string | 是 | 执行的导出 SQL 语句。 | SELECT * FROM DMS_test LIMIT 20; |
| Watermark | object | 否 | 水印相关信息。 | |
| WatermarkTypes | array | 否 | 水印嵌入类型。 | |
| string | 否 | DATA | ||
| Keys | array | 否 | 主键或唯一键。 | |
| string | 否 | 主键或唯一键信息，多个数据之间使用英文逗号（,）分割。 | ID | |
| ColumnName | string | 否 | 数据水印嵌入字段名称。 | user_number |
| DataWatermark | string | 否 | 数据水印信息。 | 测试 |
| FileWatermark | string | 否 | 文件水印信息。 | 测试 |
| Tid | long | 否 | 租户 ID。 说明
取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。
| 3*** |
| RealLoginUserUid | string | 否 | 实际调用 API 的用户的阿里云账号 UID。 | 21400447956867**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"CreateOrderResult": {
"CreateOrderResult": [
0
]
},
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-11 | OpenAPI 入参发生变更 | 查看变更详情 |