全部产品
Search
文档中心

数据管理 DMS:ExecuteDataExport - 执行数据导出工单

更新时间:Mar 28, 2024

调用ExecuteDataExport执行数据导出工单。

接口说明

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
-1
OrderIdlong

工单 ID。

1234
ActionDetailobject

执行操作参数:

{
  "mode" : "FAST",  // 数据导出模式,默认 FAST,NORMAL 允许进行中断
  "encoding" : "UTF8",  //编码
  "startTime" : "2022-12-22 00:00:00",  // 开始导出时间
  "transaction" : false,    // 是否启用事务
  "fileType" : "SQL"    // 导出格式
}
说明 除如上示例的取值,mode、encoding、fileType 还支持如下取值:
  • mode:NORMAL。
  • encoding:UTF8MB4、GB2312、ISO_8859_1、GBK、LATAIN1、CP1252。
  • fileType:XLSX、CSV、JSON、TXT。
  • { "fileType": "CSV", "encoding": "" }

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    FE8EE2F1-4880-46BC-A704-5CF63EAF9A04
    ErrorCodestring

    错误码。

    UnknownError
    ErrorMessagestring

    错误信息。

    UnknownError
    Successboolean

    请求是否成功。

    true

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF9A04",
      "ErrorCode": "UnknownError",
      "ErrorMessage": "UnknownError",
      "Success": true
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史