ListMigrations - 大数据开发治理平台 DataWorks

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListMigrations	系统规定参数。取值：ListMigrations。
RegionId	String	是	cn-shanghai	地域信息，通常是服务所在的地域。例如，华东2（上海）是cn-shanghai，华北3（张家口）是cn-zhangjiakou。您无需填写RegionId，会根据调用的endpoint自动解析。
ProjectId	Long	是	12345	DataWorks工作空间的ID。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间ID。
MigrationType	String	是	IMPORT	迁移任务的操作类型。包括：IMPORT、EXPORT。
Owner	String	否	193379****	负责人的ID。
PageNumber	Integer	否	1	请求数据的页码数。
PageSize	Integer	否	10	每页显示的数据条数，最大值为100。

返回数据


名称	类型	示例值	描述
RequestId	String	F9198AA3-9010-53D5-9714-DC4461427D3E	请求ID，一次请求的唯一标识。
Success	Boolean	true	请求是否成功。取值如下： true：成功。 false：失败。
Data	Object		返回数据。
Migrations	Array of Migration		迁移任务列表。
Id	Long	436064	主键ID。
Name	String	test_task_1638498642279	任务名称。
PackageType	String	DATAWORKS_MODEL	导入导出包的类型，取值如下： DWMA（标准格式） DATAWORKS_MODEL（标准格式） DATAWORKS_V2（专有云（V3.6.1-V3.11）） DATAWORKS_V3（专有云（V3.12及以上）） DWMA和DATAWORKS_MODEL可通用
MigrationType	String	EXPORT	迁移任务的操作类型。 IMPORT EXPORT
CreateTime	Long	123124123123123	创建时间。
UpdateTime	Long	123123123123123	更新时间。
CreateUser	String	123123****	创建人。
CreateUserName	String	3h1_test	创建人名称。
UpdateUser	String	1231****	更新人。
UpdateUserName	String	3h1_test	更新人名称。
ProjectId	Long	72132	任务所在DataWorks空间的ID。
TenantId	Long	16307	租户ID。
Status	String	SUCCESS	导入导出迁移任务的执行状态。取值如下： INIT：任务为初始状态。 EDITING：任务在编辑中。 RUNNING，任务在运行中。 FAILURE，任务运行失败。 SUCCESS，任务运行成功。
Message	String	An internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it	错误信息。
DownloadUrl	String	http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx	导出任务包的下载链接。您可以通过该链接下载导出任务。
Description	String	自动化测试创建	导出任务的描述信息。
PageNumber	Integer	1	当前的页数。
PageSize	Integer	10	每页显示的条数，默认为10条，最大为50条。
TotalCount	Integer	20	总记录数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListMigrations
&ProjectId=12345
&MigrationType=IMPORT
&Owner=193379****
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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&amp;OSSAccessKeyId=XXXXXXeF4Lv5j&amp;Signature=qxxxxx",
      "Description" : "自动化测试创建"
    },
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 20
  }
}

错误码

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