文档

ListMigrations - 获取迁移任务列表

更新时间:

获取导入导出迁移任务列表。

调试

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

授权信息

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

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

请求参数

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

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

12345
MigrationTypestring

迁移任务的操作类型。包括:IMPORT、EXPORT。

IMPORT
Ownerstring

负责人的 ID。

193379****
PageNumberinteger

请求数据的页码数。默认值:1 ,最大值 100

1
PageSizeinteger

每页显示的数据条数,默认值 10,最大值为 100。

10

返回参数

名称类型描述示例值
object

返回数据结构。

RequestIdstring

请求 ID,一次请求的唯一标识。

F9198AA3-9010-53D5-9714-DC4461427D3E
Successboolean

请求是否成功。取值如下:

  • true:成功。
  • false:失败。
true
Dataobject

返回数据。

Migrationsobject []

迁移任务列表。

Idlong

主键 ID。

436064
Namestring

任务名称。

test_task_1638498642279
PackageTypestring

导入导出包的类型,取值如下:

  • DWMA(标准格式)
  • DATAWORKS_MODEL(标准格式)
  • DATAWORKS_V2(专有云(V3.6.1-V3.11))
  • DATAWORKS_V3(专有云(V3.12 及以上))

DWMA 和 DATAWORKS_MODEL 可通用

DATAWORKS_MODEL
MigrationTypestring

迁移任务的操作类型。

  • IMPORT
  • EXPORT
EXPORT
CreateTimelong

创建时间。

123124123123123
UpdateTimelong

更新时间。

123123123123123
CreateUserstring

创建人。

123123****
CreateUserNamestring

创建人名称。

3h1_test
UpdateUserstring

更新人。

1231****
UpdateUserNamestring

更新人名称。

3h1_test
ProjectIdlong

任务所在 DataWorks 空间的 ID。

72132
TenantIdlong

租户 ID。

16307
Statusstring

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

  • INIT:任务为初始状态。
  • EDITING:任务在编辑中。
  • RUNNING,任务在运行中。
  • FAILURE,任务运行失败。
  • SUCCESS,任务运行成功。
SUCCESS
Messagestring

错误信息。

An internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it
DownloadUrlstring

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

http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx
Descriptionstring

导出任务的描述信息。

自动化测试创建
PageNumberinteger

当前的页数。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大为 50 条。

10
TotalCountinteger

总记录数。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "F9198AA3-9010-53D5-9714-DC4461427D3E",
  "Success": true,
  "Data": {
    "Migrations": [
      {
        "Id": 436064,
        "Name": "test_task_1638498642279",
        "PackageType": "DATAWORKS_MODEL",
        "MigrationType": "EXPORT",
        "CreateTime": 123124123123123,
        "UpdateTime": 123123123123123,
        "CreateUser": "123123****",
        "CreateUserName": "3h1_test",
        "UpdateUser": "1231****",
        "UpdateUserName": "3h1_test",
        "ProjectId": 72132,
        "TenantId": 16307,
        "Status": "SUCCESS",
        "Message": "An internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it",
        "DownloadUrl": "http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx",
        "Description": "自动化测试创建"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 20
  }
}

错误码

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

变更历史

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