调用DescribeReplicationJobs查询一个或多个迁移任务的详细信息。
接口说明
- 请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。
- 支持迁移源的迁移目标为Docker容器镜像,实现低成本容器化应用迁移。关于Docker容器镜像详情请参见容器镜像服务。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeReplicationJobs | 系统规定参数。取值:DescribeReplicationJobs。 |
Name | String | 否 | testMigrationTaskName | 迁移任务的名称。 |
RegionId | String | 否 | cn-hangzhou | 迁移源需迁入的目标阿里云地域ID。 例如,您需要迁移源服务器至杭州,则RegionId为 |
Status | String | 否 | Ready | 迁移任务的主状态。取值范围:
|
BusinessStatus | String | 否 | Preparing | 迁移任务的业务状态。取值范围:
|
PageNumber | Integer | 否 | 1 | 返回结果中,迁移任务列表的页码。起始值:1。 默认值:1。 |
PageSize | Integer | 否 | 10 | 分页查询时设置的每页行数。最大值:50。 默认值:10。 |
SourceId.N | String | 否 | s-bp1bjhkwk2j5hlbn**** | 迁移源ID列表。N的最大值为50。 |
JobId.N | String | 否 | j-bp1h3d33mekxwu0n**** | 迁移任务ID列表。N的最大值:50。 |
JobType | Integer | 否 | 0 | 迁移任务的类型。取值范围:
|
InstanceId.N | String | 否 | i-bp1f1dvfto1sigz5**** | 目标实例ID。 |
ResourceGroupId | String | 否 | rg-acfmw3ty5y7**** | 资源组ID。 |
Tag.N.Key | String | 否 | TestKey | 为SMC资源指定的标签键。N的取值范围:1~20。 一旦传入该值,可以为空字符串。最多支持64个字符,不能包含http://或者https://。 |
Tag.N.Value | String | 否 | TestValue | 为SMC资源指定的标签值。N的取值范围:1~20。 一旦传入该值,可以为空字符串。最多支持64个字符,不能包含http://或者https://。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Integer | 5 | 迁移任务总个数。 |
ReplicationJobs | Array of ReplicationJob | 迁移任务详情的集合。 |
|
ReplicationJob | |||
Frequency | Integer | 15 | 增量迁移任务自动执行的时间间隔,单位:小时。取值范围:1~168。 |
VpcId | String | vpc-bp1vwnn14rqpyiczj**** | 已配置高速通道服务或者VPN网关的VPC ID。 |
CreationTime | String | 2014-07-24T13:00:52Z | 迁移任务的创建时间。 |
Status | String | Running | 迁移任务的主状态。可能值:
|
ScheduledStartTime | String | 2019-06-04T13:35:00Z | 迁移任务的执行时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。该参数值的设置需满足以下要求:
|
MaxNumberOfImageToKeep | Integer | 8 | 增量迁移任务默认保留的最大镜像数。取值范围:1~10。 |
ContainerNamespace | String | testNamespace | Docker的命名空间。 |
DataDisks | Array of DataDisk | 目标阿里云服务器ECS的数据盘。 |
|
DataDisk | |||
Index | Integer | 1 | 数据盘顺序。 |
Size | Integer | 40 | 数据盘大小。单位:GiB。 |
Parts | Array of Part | 数据盘分区信息。 |
|
Part | |||
SizeBytes | Long | 21474836480 | 数据盘分区大小。单位:Byte。 |
Block | Boolean | true | 分区是否开启块复制。 |
Device | String | 0_1 | 数据盘分区设备标识。 |
StatusInfo | String | statusinfo | 迁移状态的详细信息。 |
InstanceRamRole | String | SMCAdmin | 实例RAM角色名称。 |
SystemDiskSize | Integer | 40 | 目标阿里云服务器ECS的系统盘大小。 |
Description | String | This is my migration task. | 迁移任务的描述。 |
ReplicationParameters | String | BandWidthLimit:0 | 复制驱动器参数信息。 |
ErrorCode | String | InternalError | 迁移任务的错误码。 |
ValidTime | String | 2019-06-08T14:40:52Z | 迁移任务的过期时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 说明 +8小时后是控制台上显示的时间。 |
NetMode | Integer | 0 | 迁移时使用的网络类型。 |
ContainerTag | String | CentOS:v1 | Docker的镜像标签。 |
LicenseType | String | BYOL | 迁移任务的许可证类型。可能值:
|
Name | String | testMigrationTaskName | 迁移任务名称。 |
ImageId | String | m-o6w3gy99qf89rkga**** | 迁移任务交付的目标镜像ID。 |
Progress | Float | 100 | 迁移任务总进度。 |
RunOnce | Boolean | true | 区分一次性迁移任务和增量迁移任务。可能值:
|
LaunchTemplateId | String | lt-launchtemplateid | 实例启动模板ID。 |
ContainerRepository | String | testRepository | Docker的镜像仓库。 |
InstanceId | String | i-bp1ff25rzvnul6kr**** | 目标实例ID。 |
SystemDiskParts | Array of SystemDiskPart | 系统盘分区信息。 |
|
SystemDiskPart | |||
SizeBytes | Long | 254803968 | 系统盘分区大小。单位:Byte。 |
Block | Boolean | true | 系统盘分区是否开启块复制。 |
Device | String | 0_1 | 系统盘分区设备标识符。 |
InstanceType | String | ecs.sn1ne.large | 中转实例的实例规格。 |
SourceId | String | s-bp1e2fsl57knvuug**** | 迁移源ID。 |
LaunchTemplateVersion | String | 1 | 一个或多个实例启动模板版本。 |
RegionId | String | cn-hangzhou | 迁移源需迁入的目标阿里云地域ID。 |
TransitionInstanceId | String | i-bp1ff25rzvnul6kr**** | 迁移中转实例ID。 |
EndTime | String | 2019-06-04T16:00:52Z | 迁移任务的完成时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 说明 +8小时后是控制台上显示的时间。 |
StartTime | String | 2019-06-04T14:40:52Z | 迁移任务的开始时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 说明 +8小时后是控制台上显示的时间。 |
VSwitchId | String | vsw-bp1ddbrxdlrcbim46**** | 指定VPC下的虚拟交换机ID。 |
JobId | String | j-bp19vlwm0tyigbmj**** | 迁移任务ID。 |
ImageName | String | testAliCloudImageName | 迁移任务交付的目标镜像名称。 |
BusinessStatus | String | Preparing | 迁移任务的业务状态。可能值:
|
ReplicationJobRuns | Array of ReplicationJobRun | 迁移任务运行记录。 |
|
ReplicationJobRun | |||
EndTime | String | 2019-10-04T13:35:00Z | 迁移任务运行的结束时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 说明 +8小时后是控制台上显示的时间。 |
Type | String | Schedule | 迁移任务的执行方式。可能值:
|
StartTime | String | 2019-10-01T13:35:00Z | 迁移任务运行的开始时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 说明 +8小时后是控制台上显示的时间。 |
ImageId | String | m-o6w3gy99qf89rkga**** | 迁移任务生成的镜像ID。 |
TargetType | String | Image | 迁移交付的目标类型。可能值:
|
JobType | Integer | 0 | 迁移任务的类型。可能值:
|
ResourceGroupId | String | rg-acfmw3ty5y7**** | 资源组ID。 |
Tags | Array of Tag | 为SMC资源指定的标签。 |
|
Tag | |||
Key | String | TestKey | 为SMC资源指定的标签键。N的取值范围:1~20。 一旦传入该值,可以为空字符串。最多支持64个字符,不能包含http://或者https://。 |
Value | String | TestValue | 为SMC资源指定的标签值。N的取值范围:1~20。 一旦传入该值,可以为空字符串。最多支持64个字符,不能包含http://或者https://。 |
PageSize | Integer | 10 | 每页行数。 |
RequestId | String | 6E1187E8-843A-4850-B97E-2F17F00D48F7 | 请求ID。 |
PageNumber | Integer | 1 | 迁移任务列表的页码。 |
示例
请求示例
http(s)://smc.aliyuncs.com/?Action=DescribeReplicationJobs
&Name=testMigrationTaskName
&RegionId=cn-hangzhou
&Status=Ready
&BusinessStatus=Preparing
&PageNumber=1
&PageSize=10
&SourceId=["s-bp1bjhkwk2j5hlbn****"]
&JobId=["j-bp1h3d33mekxwu0n****"]
&JobType=0
&InstanceId=["i-bp1f1dvfto1sigz5****"]
&ResourceGroupId=rg-acfmw3ty5y7****
&Tag=[{"Key":"TestKey","Value":"TestValue"}]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeReplicationJobsResponse>
<TotalCount>5</TotalCount>
<ReplicationJobs>
<Frequency>15</Frequency>
<VpcId>vpc-bp1vwnn14rqpyiczj****</VpcId>
<CreationTime>2014-07-24T13:00:52Z</CreationTime>
<Status>Running</Status>
<ScheduledStartTime>2019-06-04T13:35:00Z</ScheduledStartTime>
<MaxNumberOfImageToKeep>8</MaxNumberOfImageToKeep>
<ContainerNamespace>testNamespace</ContainerNamespace>
<DataDisks>
<Index>1</Index>
<Size>40</Size>
<Parts>
<SizeBytes>21474836480</SizeBytes>
<Block>true</Block>
<Device>0_1</Device>
</Parts>
</DataDisks>
<StatusInfo>statusinfo</StatusInfo>
<InstanceRamRole>SMCAdmin</InstanceRamRole>
<SystemDiskSize>40</SystemDiskSize>
<Description>This is my migration task.</Description>
<ReplicationParameters>BandWidthLimit:0</ReplicationParameters>
<ErrorCode>InternalError</ErrorCode>
<ValidTime>2019-06-08T14:40:52Z</ValidTime>
<NetMode>0</NetMode>
<ContainerTag>CentOS:v1</ContainerTag>
<LicenseType>BYOL</LicenseType>
<Name>testMigrationTaskName</Name>
<ImageId>m-o6w3gy99qf89rkga****</ImageId>
<Progress>100</Progress>
<RunOnce>true</RunOnce>
<LaunchTemplateId>lt-launchtemplateid</LaunchTemplateId>
<ContainerRepository>testRepository</ContainerRepository>
<InstanceId>i-bp1ff25rzvnul6kr****</InstanceId>
<SystemDiskParts>
<SizeBytes>254803968</SizeBytes>
<Block>true</Block>
<Device>0_1</Device>
</SystemDiskParts>
<InstanceType>ecs.sn1ne.large</InstanceType>
<SourceId>s-bp1e2fsl57knvuug****</SourceId>
<LaunchTemplateVersion>1</LaunchTemplateVersion>
<RegionId>cn-hangzhou</RegionId>
<TransitionInstanceId>i-bp1ff25rzvnul6kr****</TransitionInstanceId>
<EndTime>2019-06-04T16:00:52Z</EndTime>
<StartTime>2019-06-04T14:40:52Z</StartTime>
<VSwitchId>vsw-bp1ddbrxdlrcbim46****</VSwitchId>
<JobId>j-bp19vlwm0tyigbmj****</JobId>
<ImageName>testAliCloudImageName</ImageName>
<BusinessStatus>Preparing</BusinessStatus>
<ReplicationJobRuns>
<EndTime>2019-10-04T13:35:00Z</EndTime>
<Type>Schedule</Type>
<StartTime>2019-10-01T13:35:00Z</StartTime>
<ImageId>m-o6w3gy99qf89rkga****</ImageId>
</ReplicationJobRuns>
<TargetType>Image</TargetType>
<JobType>0</JobType>
<ResourceGroupId>rg-acfmw3ty5y7****</ResourceGroupId>
<Tags>
<Key>TestKey</Key>
<Value>TestValue</Value>
</Tags>
</ReplicationJobs>
<PageSize>10</PageSize>
<RequestId>6E1187E8-843A-4850-B97E-2F17F00D48F7</RequestId>
<PageNumber>1</PageNumber>
</DescribeReplicationJobsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 5,
"ReplicationJobs" : [ {
"Frequency" : 15,
"VpcId" : "vpc-bp1vwnn14rqpyiczj****",
"CreationTime" : "2014-07-24T13:00:52Z",
"Status" : "Running",
"ScheduledStartTime" : "2019-06-04T13:35:00Z",
"MaxNumberOfImageToKeep" : 8,
"ContainerNamespace" : "testNamespace",
"DataDisks" : [ {
"Index" : 1,
"Size" : 40,
"Parts" : [ {
"SizeBytes" : 21474836480,
"Block" : true,
"Device" : "0_1"
} ]
} ],
"StatusInfo" : "statusinfo",
"InstanceRamRole" : "SMCAdmin",
"SystemDiskSize" : 40,
"Description" : "This is my migration task.",
"ReplicationParameters" : "BandWidthLimit:0",
"ErrorCode" : "InternalError",
"ValidTime" : "2019-06-08T14:40:52Z",
"NetMode" : 0,
"ContainerTag" : "CentOS:v1",
"LicenseType" : "BYOL",
"Name" : "testMigrationTaskName",
"ImageId" : "m-o6w3gy99qf89rkga****",
"Progress" : 100,
"RunOnce" : true,
"LaunchTemplateId" : "lt-launchtemplateid",
"ContainerRepository" : "testRepository",
"InstanceId" : "i-bp1ff25rzvnul6kr****",
"SystemDiskParts" : [ {
"SizeBytes" : 254803968,
"Block" : true,
"Device" : "0_1"
} ],
"InstanceType" : "ecs.sn1ne.large",
"SourceId" : "s-bp1e2fsl57knvuug****",
"LaunchTemplateVersion" : "1",
"RegionId" : "cn-hangzhou",
"TransitionInstanceId" : "i-bp1ff25rzvnul6kr****",
"EndTime" : "2019-06-04T16:00:52Z",
"StartTime" : "2019-06-04T14:40:52Z",
"VSwitchId" : "vsw-bp1ddbrxdlrcbim46****",
"JobId" : "j-bp19vlwm0tyigbmj****",
"ImageName" : "testAliCloudImageName",
"BusinessStatus" : "Preparing",
"ReplicationJobRuns" : [ {
"EndTime" : "2019-10-04T13:35:00Z",
"Type" : "Schedule",
"StartTime" : "2019-10-01T13:35:00Z",
"ImageId" : "m-o6w3gy99qf89rkga****"
} ],
"TargetType" : "Image",
"JobType" : 0,
"ResourceGroupId" : "rg-acfmw3ty5y7****",
"Tags" : [ {
"Key" : "TestKey",
"Value" : "TestValue"
} ]
} ],
"PageSize" : 10,
"RequestId" : "6E1187E8-843A-4850-B97E-2F17F00D48F7",
"PageNumber" : 1
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbidden.Unauthorized | A required authorization for the specified action is not supplied. | 用户未授权操作指定的资源。 |
500 | InternalError | An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
访问错误中心查看更多错误码。