全部产品
Search

搜索本产品

    数据管理 DMS：GetDataExportOrderDetail - 获取SQL结果集导出工单详情

    文档中心

    数据管理 DMS：GetDataExportOrderDetail - 获取SQL结果集导出工单详情

    更新时间：Nov 06, 2024

    获取SQL结果集导出工单详情。

    调试

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

    授权信息

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

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

    请求参数

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

    租户 ID。

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

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

    		818****

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
    DataExportOrderDetailobject

    SQL 结果集导出工单详情信息。

    KeyInfoobject

    状态信息。

    PreCheckIdlong

    预校验 ID。

    		6393****
    JobStatusstring

    导出工单状态，取值如下：

    • PRE_CHECKING：执行预校验。
    • PRE_CHECK_SUCCESS：预校验成功。
    • PRE_CHECK_FAIL：预校验失败。
    • WAITING_APPLY_AUDIT：等待提交审批。
    • APPLY_AUDIT_SUCCESS：提交审批成功。
    • ENABLE_EXPORT：审批通过，允许导出。
    • WAITING_EXPORT：等待调度进行导出。
    • DOING_EXPORT：执行导出。
    • EXPORT_FAIL：导出失败。
    • EXPORT_SUCCESS：导出成功。
    		EXPORT_SUCCESS
    JobIdlong

    导出任务 ID。

    		1385****
    OrderDetailobject

    工单详情信息。

    DbIdinteger

    数据库 ID。

    		3733****
    Databasestring

    导出的数据库名称。

    		xxx@xxx:3306
    Classifystring

    导出工单的原因类别。

    		text
    ExeSQLstring

    执行的导出 SQL 语句。

    		SELECT * FROM DMS_test LIMIT 20;
    Logicboolean

    是否为逻辑库。

    		false
    ActualAffectRowslong

    系统校验影响的 SQL 行数。

    		1
    IgnoreAffectRowsboolean

    是否忽略影响行数。

    		false
    IgnoreAffectRowsReasonstring

    忽略校验原因。

    		empty
    EnvTypestring

    导出数据库环境信息。

    		test
    ErrorCodestring

    错误码。

    		UnknownError
    ErrorMessagestring

    错误信息。

    		UnknownError
    Successboolean

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

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

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "DataExportOrderDetail": {
    "KeyInfo": {
      "PreCheckId": 0,
      "JobStatus": "EXPORT_SUCCESS",
      "JobId": 0
    },
    "OrderDetail": {
      "DbId": 0,
      "Database": "xxx@xxx:3306",
      "Classify": "text",
      "ExeSQL": "SELECT * FROM DMS_test\n LIMIT 20;",
      "Logic": false,
      "ActualAffectRows": 1,
      "IgnoreAffectRows": false,
      "IgnoreAffectRowsReason": "empty",
      "EnvType": "test"
    }
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-10-15OpenAPI 返回结构发生变更查看变更详情