文档

GetMigrationSummary - 获取导入导出任务的信息

更新时间:

调用GetMigrationSummary,获取导入导出任务的信息。

调试

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

授权信息

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

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

请求参数

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

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。

12345
MigrationIdlong

导入导出任务的 ID。

您可以调用 CreateImportMigration 接口获取导入任务的 ID,调用 CreateExportMigration 接口获取导出任务的 ID。

1234

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

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

19999A96-71BA-1845-B455-ED620EF4E37F
Successboolean

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。您可以通过请求 ID 定位问题。
true
Dataobject

请求返回的导入导出任务详情。

MigrationIdlong

任务的 ID。

1234
Namestring

任务的名称。

test_export_01
GmtCreatelong

任务的创建时间。

1589904000000
GmtModifiedlong

任务的修改时间。

1589904000000
CreateUserstring

任务创建人的用户 ID。

982293332403****
OpUserstring

任务操作人的用户 ID。

982293332403****
Statusstring

导入导出任务的执行状态。取值如下:

  • INIT:任务为初始状态。
  • EDITING:任务在编辑中。
  • IMPORTING:任务在导入中。
  • IMPORT_ERROR:任务导入失败。
  • IMPORT_SUCCESS:任务导入成功。
  • EXPORTING:任务在导出中。
  • EXPORT_ERROR:任务导出失败。
  • EXPORT_SUCCESS:任务导出成功。
  • REVOKED:任务被取消。
  • PARTIAL_SUCCESS:仅部分任务导入或导出成功。
EXPORT_SUCCESS
ProjectIdlong

任务所在 DataWorks 空间的 ID。

12345
DownloadUrlstring

导出任务包的下载链接。您可以通过该链接下载导出任务。

https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "19999A96-71BA-1845-B455-ED620EF4E37F",
  "Success": true,
  "Data": {
    "MigrationId": 1234,
    "Name": "test_export_01",
    "GmtCreate": 1589904000000,
    "GmtModified": 1589904000000,
    "CreateUser": "982293332403****",
    "OpUser": "982293332403****",
    "Status": "EXPORT_SUCCESS",
    "ProjectId": 12345,
    "DownloadUrl": "https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)