全部产品
Search
文档中心

数据管理 DMS:GetDatabaseExportOrderDetail - 获取数据库导出工单详情

更新时间:Nov 28, 2024

获取数据库导出工单详情。

调试

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

授权信息

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

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

请求参数

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

租户 ID。

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

工单 ID,可调用 ListOrders 接口获取该参数的值。

821****

返回参数

名称类型描述示例值
object
RequestIdstring

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

CFD8FE00-36D9-4C1B-940D-65A7B73D9066
DatabaseExportOrderDetailobject

数据库导出工单详情。

Idlong

工单 ID。

821****
Committerstring

工单提交者。

dmsuser
CommitterIdstring

工单提交者的用户 ID,非阿里云 UID。

12***
Commentstring

提交数据导出工单的业务背景。

测试
SearchNamestring

数据库搜索名称。

test@xxx.xxx.xxx.xxx:3306
StatusDescstring

工单状态描述。

工单审批中。
WorkflowStatusDescstring

工作流状态描述。

工单审批中。
KeyInfoobject

关键信息。

DbIdlong

数据库 ID。

2583****
DownloadURLstring

导出结果的下载地址。

https://oss.xxx.com
AuditDatestring

提交工单时间。

2023-04-13 13:44:59
Configobject

配置信息。

DbNamestring

数据库名称。

dmstest
ExportContentstring

导出内容。取值如下:

  • DATA:数据。
  • STRUCT:结构。
  • DATA_STRUCT:数据和结构。
DATA
TargetOptionstring

导出格式。取值如下:

  • SQL
  • CSV
  • XLSX
SQL
ExportTypesarray

导出结构类型。

ExportTypesstring

取值如下:

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

选中导出哪些表。

SelectedTablesstring

表名。

user_test
SQLExtOptionarray

SQL 脚本拓展选项。

SQLExtOptionstring

选项列表:

  • DROP:在 CREATE 语句前生成 DROP TABLE 语句。
  • TRUNCATE:在 INSERT 语句前生成 TRUNCATE TABLE 语句。
  • COMPRESS:压缩 INSERT 语句,将 VLAUES 合并为 5 M 大小。
DROP
Logstring

执行日志。

2023-04-12 14:58:32:015 Database Dump Start. 2023-04-12 14:58:32:096 set server side query timeout, sql : set max_execution_time = 0
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

调用失败时,返回的错误信息。

UnknownError
Successboolean

请求是否成功,返回值如下:

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

示例

正常返回示例

JSON格式

{
  "RequestId": "CFD8FE00-36D9-4C1B-940D-65A7B73D9066",
  "DatabaseExportOrderDetail": {
    "Id": 0,
    "Committer": "dmsuser",
    "CommitterId": "12***",
    "Comment": "测试",
    "SearchName": "test@xxx.xxx.xxx.xxx:3306",
    "StatusDesc": "工单审批中。",
    "WorkflowStatusDesc": "工单审批中。",
    "KeyInfo": {
      "DbId": 0,
      "DownloadURL": "https://oss.xxx.com",
      "AuditDate": "2023-04-13 13:44:59",
      "Config": {
        "DbName": "dmstest",
        "ExportContent": "DATA",
        "TargetOption": "SQL",
        "ExportTypes": {
          "ExportTypes": [
            "PROCEDURE"
          ]
        },
        "SelectedTables": {
          "SelectedTables": [
            "user_test"
          ]
        },
        "SQLExtOption": {
          "SQLExtOption": [
            "DROP"
          ]
        }
      }
    },
    "Log": "2023-04-12 14:58:32:015 Database Dump Start.\n2023-04-12 14:58:32:096 set server side query timeout, sql : set max_execution_time = 0"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

错误码

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

变更历史

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