首页 数据管理 DMS 开发参考 API参考 API目录 工单操作 数据导出 CreateDatabaseExportOrder - 创建数据库导出工单

CreateDatabaseExportOrder - 创建数据库导出工单

更新时间: 2023-09-15 10:12:37

创建数据库导出工单。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:CreateDatabaseExportOrderWrite
    全部资源
    无
无

请求参数

名称类型必填描述示例值
ParentIdlong否

父工单ID。

 877****
Commentstring是

业务背景，描述提工单的原因，以减少沟通成本。

文档测试
AttachmentKeystring否

工单附件Key，补充当前工单信息。可通过调用接口GetUserUploadFileJob获取该参数的值。

order_attachment.txt
PluginParamobject是

工单参数。

Classifystring是

导出原因。

文档测试
DbIdlong是

数据库ID。您可通过调用GetDatabase获取该参数的值。

17****
InstanceIdlong是

实例ID。您可通过调用GetInstance接口获取该参数的值。

137****
Logicboolean是

是否为逻辑库，取值如下：

  • true：是
  • false：否
true
Configobject是

导出配置。

SQLExtOptionarray是

SQL脚本拓展选项。列表长度可为0。

string否

选项列表：

  • DROP：在CREATE语句前生成DROP TABLE语句。
  • TRUNCATE：在INSERT语句前生成TRUNCATE TABLE语句。
  • COMPRESS：压缩INSERT语句，将VLAUES合并为5 M大小。
DROP
DataOptionarray是

大数据导出选项，用于筛选需要导出哪些大数据类型。列表长度可为0。

string否

导出选项：

  • BLOB：导出BLOG、TINYBLOB等类型。
  • TEXT：导出TEXT、TNIYTEXT等类型。
  • BINARY：导出BINARY、VARBINARY灯类型。
BLOB
ExportContentstring是

导出内容。取值如下：

  • DATA：数据。
  • STRUCT：结构。
  • DATA_STRUCT：数据和结构。
DATA
ExportTypesarray否

导出结构类型。

string否

取值如下（可多选）：

  • PROCEDURE：存储过程。
  • FUNCTION：函数。
  • TRIGGER：触发器。
  • VIEW：视图。
  • EVENT：事件。
PROCEDURE
SelectedTablesarray否

导出的表列表。

string否

选中导出哪些表。

dmstest_table
Tablesobject否

导出表过滤条件。

string否

过滤条件。

where 1=1
TargetOptionstring是

导出格式。取值如下：

  • SQL
  • CSV
  • XLSX
SQL
SearchNamestring是

数据库搜索名称。

test@xxx.xxx.xxx.xxx:3306
RelatedUserListarray否

相关人列表。

long否

变更相关人的用户ID。设置的相关人员可查看工单，并协同工作，非相关人员则不能查看工单（管理员、DBA除外）。

2452345113****
Tidlong否

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息，详情请参见查看租户信息。
3***

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID，用于定位日志，排查问题。

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

调用失败时，返回的出错信息。

UnknownError
CreateOrderResultarray

创建的工单包含的信息。

long

工单ID。

12***
Successboolean

请求是否成功，返回值如下：

  • true：请求成功
  • false：请求失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "CreateOrderResult": {
    "CreateOrderResult": [
      0
    ]
  },
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 数据管理 DMS 相关技术圈