全部产品
Search

搜索本产品

    数据管理 DMS：CreateDatabaseExportOrder - 创建数据库导出工单

    文档中心

    数据管理 DMS：CreateDatabaseExportOrder - 创建数据库导出工单

    更新时间：Aug 28, 2026

    创建数据库导出工单。

    接口说明

    仅管控模式为安全协同的数据库实例可调用此 API。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dms:CreateDatabaseExportOrder

    create

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    ParentId

    integer

    否

    父工单 ID。

    877****
    Comment

    string

    是

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

    文档测试
    AttachmentKey

    string

    否

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

    order_attachment.txt
    PluginParam

    object

    是

    工单参数。

    Classify

    string

    是

    导出原因。

    文档测试
    DbId

    integer

    是

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

    17****
    InstanceId

    integer

    是

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

    137****
    Logic

    boolean

    是

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

    • true：是

    • false：否

    false
    Config

    object

    是

    导出配置。

    SQLExtOption

    array

    是

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

    string

    否

    选项列表：

    • DROP：在 CREATE 语句前生成 DROP TABLE 语句。

    • TRUNCATE：在 INSERT 语句前生成 TRUNCATE TABLE 语句。

    • COMPRESS：压缩 INSERT 语句，将 VALUES 合并为 5 M 大小。

    DROP
    DataOption

    array

    是

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

    string

    否

    导出选项：

    • BLOB：导出 BLOG、TINYBLOB 等类型。

    • TEXT：导出 TEXT、TNIYTEXT 等类型。

    • BINARY：导出 BINARY、VARBINARY 等类型。

    BLOB
    ExportContent

    string

    是

    导出内容。取值如下：

    • DATA：数据。

    • STRUCT：结构。

    • DATA_STRUCT：数据和结构。

    DATA
    ExportTypes

    array

    否

    导出结构类型。

    string

    否

    取值如下（可多选）：

    • PROCEDURE：存储过程。

    • FUNCTION：函数。

    • TRIGGER：触发器。

    • VIEW：视图。

    • EVENT：事件。

    PROCEDURE
    SelectedTables

    array

    否

    导出的表列表。

    string

    否

    选中导出哪些表。

    dmstest_table
    Tables

    object

    否

    导出表过滤条件。

    string

    否

    过滤条件。

    where 1=1
    TargetOption

    string

    是

    导出格式。取值如下：

    • SQL

    • CSV

    • XLSX

    SQL
    SearchName

    string

    是

    数据库搜索名称。

    test@xxx.xxx.xxx.xxx:3306
    RelatedUserList

    array

    否

    相关人列表。

    integer

    否

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

    2452345113****
    Tid

    integer

    否

    租户 ID。

    说明

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

    3***

    返回参数

    名称

    类型

    描述

    示例值

    object

    RequestId

    string

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

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

    string

    错误码。

    UnknownError
    ErrorMessage

    string

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

    UnknownError
    CreateOrderResult

    object

    CreateOrderResult

    array

    创建的工单包含的信息。

    integer

    工单 ID。

    12***
    Success

    boolean

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

    • true：请求成功

    • false：请求失败

    true

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    更多信息，参考变更详情。