调用DescribeReplicationJobs查询一个或多个迁移任务的详细信息。

接口说明

请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeReplicationJobs

系统规定参数。取值:DescribeReplicationJobs。

BusinessStatus String Preparing

迁移任务的业务状态。取值:

  • Preparing(准备中)
  • Syncing(同步中)
  • Processing(处理中)
  • Cleaning(清理中)
JobId.N RepeatList j-xxxxxxxxxxxxxxx

迁移任务ID列表。N的最大值:50

Name String MyMigrationTask

迁移任务的名称。

PageNumber Integer 1

返回结果中,迁移任务列表的页码。起始值:1

默认值:1

PageSize Integer 10

分页查询时设置的每页行数。最大值:50

默认值:10

RegionId String cn-hangzhou

迁移源需迁入的目标阿里云地域ID。

例如,您需要迁移源服务器至上海,则RegionId为cn-shanghai。您可以调用DescribeRegions查看最新的阿里云地域列表。

SourceId.N RepeatList s-xxxxxxxxxxxxxxx

迁移源ID列表。N的最大值:50

Status String Ready

迁移任务的主状态。取值:

  • Ready(未开始)
  • Running(运行中)
  • Stopped(已暂停)
  • InError(出错)
  • Finished(已完成)
  • Waiting(等待中)
  • Expired(已过期)
  • Deleting(删除中)

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

迁移任务列表的页码。

PageSize Integer 10

每页行数。

ReplicationJobs Array

迁移任务详情的集合。

ReplicationJob

迁移任务详情的集合。

BusinessStatus String Preparing

迁移任务的业务状态。

CreationTime String 2014-07-24T13:00:52Z

迁移任务的创建时间。

DataDisks Array

目标阿里云服务器ECS的数据盘。

DataDisk

目标阿里云服务器ECS的数据盘。

Index Integer 1

数据盘顺序。

Size Integer 40

数据盘大小,单位为GiB。

Description String This is my migration task.

迁移任务的描述。

EndTime String 2019-06-04T16:00:52Z

迁移任务的完成时间。

ErrorCode String InternalError

迁移任务的错误码。

Frequency Integer 15

增量迁移任务自动执行的时间间隔,单位:小时。取值范围:1~168

ImageId String xxxxxxxxxxxxxxxx

迁移任务交付的目标镜像ID。

ImageName String MyAliCloudImage

迁移任务交付的目标镜像名称。

InstanceId String i-xxxxxxxxxxxx

目标实例ID。

InstanceType String ecs.sn1ne.large

中转实例的实例规格。

JobId String j-xxxxxxxxxxxx

迁移任务ID。

MaxNumberOfImageToKeep Integer 8

增量迁移任务默认保留的最大镜像数。取值范围:1~10

Name String MyMigrationTask

迁移任务名称。

NetMode Integer 0

迁移时使用的网络类型。

Progress Float 55.45

迁移任务总进度。

RegionId String cn-hangzhou

迁移源需迁入的目标阿里云地域ID。

ReplicationJobRuns Array

迁移任务运行记录。

ReplicationJobRun

迁移任务运行记录。

EndTime String 2019-10-04T13:35:00Z

迁移任务运行的结束时间。

ImageId String m-xxxxxxxxxxxxxxxxxxxx

迁移任务生成的镜像ID。

StartTime String 2019-10-01T13:35:00Z

迁移任务运行的开始时间。

Type String Schedule

迁移任务的执行方式。取值:

  • Manual:手动执行。
  • Schedule:定时执行或周期执行。
ReplicationParameters String BandWidthLimit:0

复制驱动器参数信息。

RunOnce Boolean true

区分一次性迁移任务和增量迁移任务。取值:

  • true:一次性迁移任务。任务创建后仅执行一次。
  • false:增量迁移任务。任务创建后,按照Frequency设置的时间间隔,周期性自动执行。
ScheduledStartTime String 2019-06-04T13:35:00Z

迁移任务的执行时间。

SourceId String s-xxxxxxxxxxx

迁移源ID。

StartTime String 2019-06-04T14:40:52Z

迁移任务的开始时间。

Status String Running

迁移任务的主状态。

StatusInfo String statusinfo

迁移状态的详细信息。

SystemDiskSize Integer 40

目标阿里云服务器ECS的系统盘大小。

TargetType String image

迁移交付的目标类型。

TransitionInstanceId String instanceid2

迁移中转实例ID。

VSwitchId String xxxxxxxxxxxxxxx

指定VPC下的虚拟交换机ID。

ValidTime String 2019-06-08T14:40:52Z

迁移任务的过期时间。

VpcId String xxxxxxxxxxxxxxx

已配置高速通道服务或者VPN网关的VPC ID。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

TotalCount Integer 5

迁移任务总个数。

示例

请求示例


http(s)://smc.aliyuncs.com/?Action=DescribeReplicationJobs
&<公共请求参数>

正常返回示例

XML 格式

<DescribeReplicationJobsResponse>
	  <PageNumber>1</PageNumber>
	  <PageSize>10</PageSize>
	  <ReplicationJobs>
		    <ReplicationJob>
			      <BusinessStatus>Preparing</BusinessStatus>
			      <CreationTime>2014-07-24T13:00:52Z</CreationTime>
			      <DataDisks>
				        <DataDisk>
					          <Index>1</Index>
					          <Size>40</Size>
				        </DataDisk>
			      </DataDisks>
			      <Description>This is my migration task.</Description>
			      <EndTime>2019-06-04T16:00:52Z</EndTime>
			      <ErrorCode>InternalError</ErrorCode>
			      <ImageId>xxxxxxxxxxxxxxx</ImageId>
			      <ImageName>MyAilCloudImage</ImageName>
			      <InstanceId>i-xxxxxxxxxxxxxxx</InstanceId>
			      <JobId>j-xxxxxxxxxxxxxxx</JobId>
			      <Name>MyMiagrationTask</Name>
			      <NetMode>0</NetMode>
			      <Progress>55.45</Progress>
			      <RegionId>cn-hangzhou</RegionId>
			      <ReplicationParameters>BandWidthLimit:0</ReplicationParameters>
			      <ScheduledStartTime>2019-06-04T13:35:00Z</ScheduledStartTime>
			      <SourceId>s-xxxxxxxxxxxxxxx</SourceId>
			      <StartTime>2019-06-04T14:40:52Z</StartTime>
			      <Status>Running</Status>
			      <StatusInfo>statusinfo</StatusInfo>
			      <SystemDiskSize>40</SystemDiskSize>
			      <TargetType>image</TargetType>
			      <TransitionInstanceId>instanceid2</TransitionInstanceId>
			      <VSwitchId>xxxxxxxxxxxxxxx</VSwitchId>
			      <VaildTime>30</VaildTime>
			      <Vpcld>xxxxxxxxxxxxxxx</Vpcld>
		    </ReplicationJob>
	  </ReplicationJobs>
	  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
	  <TotalCount>5</TotalCount>
</DescribeReplicationJobsResponse>

JSON 格式

{
	"PageNumber":1,
	"TotalCount":"5",
	"PageSize":10,
	"RequestId":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
	"ReplicationJobs":{
		"ReplicationJob":[
			{
				"Vpcld":"xxxxxxxxxxxxxxx",
				"ImageId":"xxxxxxxxxxxxxxx",
				"InstanceId":"i-xxxxxxxxxxxxxxx",
				"VSwitchId":"xxxxxxxxxxxxxxx",
				"StatusInfo":"statusinfo",
				"ImageName":"MyAilCloudImage",
				"ScheduledStartTime":"2019-06-04T13:35:00Z",
				"BusinessStatus":"Preparing",
				"JobId":"j-xxxxxxxxxxxxxxx",
				"StartTime":"2019-06-04T14:40:52Z",
				"Description":"This is my migration task.",
				"SystemDiskSize":"40",
				"TargetType":"image",
				"VaildTime":"30",
				"DataDisks":{
					"DataDisk":[
						{
							"Index":"1",
							"Size":"40"
						}
					]
				},
				"ReplicationParameters":"BandWidthLimit:0",
				"NetMode":"0",
				"SourceId":"s-xxxxxxxxxxxxxxx",
				"Progress":"55.45",
				"Name":"MyMiagrationTask",
				"CreationTime":"2014-07-24T13:00:52Z",
				"Status":"Running",
				"RegionId":"cn-hangzhou",
				"TransitionInstanceId":"instanceid2",
				"EndTime":"2019-06-04T16:00:52Z",
				"ErrorCode":"InternalError"
			}
		]
	}
}

错误码

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