文档

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

更新时间:

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

接口说明

  • 请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。
  • 支持迁移源的迁移目标为Docker容器镜像,实现低成本容器化应用迁移。关于Docker容器镜像详情请参见容器镜像服务

调试

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

调试

授权信息

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

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

请求参数

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

迁移任务的名称。

testMigrationTaskName
RegionIdstring

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

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

cn-hangzhou
Statusstring

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

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

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

  • Preparing:准备中。
  • Syncing:同步中。
  • Processing:处理中。
  • Cleaning:清理中。
Preparing
PageNumberinteger

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

默认值:1。

1
PageSizeinteger

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

默认值:10。

10
SourceIdarray

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

string

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

s-bp1bjhkwk2j5hlbn****
JobIdarray

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

string

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

j-bp1h3d33mekxwu0n****
JobTypeinteger

迁移任务的类型。取值范围:

  • 0:服务器迁移。
  • 1:操作系统迁移。
  • 2:跨可用区迁移。
  • 3:VMware无代理迁移。
0
InstanceIdarray

实例ID。

string

目标实例ID。

i-bp1f1dvfto1sigz5****
ResourceGroupIdstring

资源组ID。

rg-acfmw3ty5y7****
Tagobject []

为SMC资源指定的标签。

Keystring

为SMC资源指定的标签键。N的取值范围:1~20。

一旦传入该值,可以为空字符串。最多支持64个字符,不能包含http://或者https://。

TestKey
Valuestring

为SMC资源指定的标签值。N的取值范围:1~20。

一旦传入该值,可以为空字符串。最多支持64个字符,不能包含http://或者https://。

TestValue

返回参数

名称类型描述示例值
object
TotalCountinteger

迁移任务总个数。

5
ReplicationJobsobject []

迁移任务详情的集合。

Frequencyinteger

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

15
VpcIdstring

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

vpc-bp1vwnn14rqpyiczj****
CreationTimestring

迁移任务的创建时间。

2014-07-24T13:00:52Z
Statusstring

迁移任务的主状态。可能值:

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

迁移任务的执行时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。该参数值的设置需满足以下要求:

  • 该参数值必须晚于当前时间,并且需要设置在30天以内。

  • 如果该参数值为空,则SMC不会启动迁移任务,需要您调用StartReplicationJob启动任务。

2019-06-04T13:35:00Z
MaxNumberOfImageToKeepinteger

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

8
ContainerNamespacestring

Docker的命名空间。

testNamespace
DataDisksobject []

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

Indexinteger

数据盘顺序。

1
Sizeinteger

数据盘大小。单位:GiB。

40
Partsobject []

数据盘分区信息。

SizeByteslong

数据盘分区大小。单位:Byte。

21474836480
Blockboolean

分区是否开启块复制。

true
Devicestring

数据盘分区设备标识。

0_1
StatusInfostring

迁移状态的详细信息。

statusinfo
InstanceRamRolestring

实例RAM角色名称。

SMCAdmin
SystemDiskSizeinteger

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

40
Descriptionstring

迁移任务的描述。

This is my migration task.
ReplicationParametersstring

复制驱动器参数信息。

BandWidthLimit:0
ErrorCodestring

迁移任务的错误码。

InternalError
ValidTimestring

迁移任务的过期时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 +8小时后是控制台上显示的时间。
2019-06-08T14:40:52Z
NetModeinteger

迁移时使用的网络类型。

0
ContainerTagstring

Docker的镜像标签。

CentOS:v1
LicenseTypestring

迁移任务的许可证类型。可能值:

  • 空值:无许可证。
  • BYOL:自带许可。
BYOL
Namestring

迁移任务名称。

testMigrationTaskName
ImageIdstring

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

m-o6w3gy99qf89rkga****
Progressfloat

迁移任务总进度。

100
RunOnceboolean

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

  • true:一次性迁移任务。任务创建后仅执行一次。

  • false:增量迁移任务。任务创建后,按照Frequency设置的时间间隔,周期性自动执行。

true
LaunchTemplateIdstring

实例启动模板ID。

lt-launchtemplateid
ContainerRepositorystring

Docker的镜像仓库。

testRepository
InstanceIdstring

目标实例ID。

i-bp1ff25rzvnul6kr****
SystemDiskPartsobject []

系统盘分区信息。

SizeByteslong

系统盘分区大小。单位:Byte。

254803968
Blockboolean

系统盘分区是否开启块复制。

true
Devicestring

系统盘分区设备标识符。

0_1
InstanceTypestring

中转实例的实例规格。

ecs.sn1ne.large
SourceIdstring

迁移源ID。

s-bp1e2fsl57knvuug****
LaunchTemplateVersionstring

一个或多个实例启动模板版本。

1
RegionIdstring

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

cn-hangzhou
TransitionInstanceIdstring

迁移中转实例ID。

i-bp1ff25rzvnul6kr****
EndTimestring

迁移任务的完成时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 +8小时后是控制台上显示的时间。
2019-06-04T16:00:52Z
StartTimestring

迁移任务的开始时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 +8小时后是控制台上显示的时间。
2019-06-04T14:40:52Z
VSwitchIdstring

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

vsw-bp1ddbrxdlrcbim46****
JobIdstring

迁移任务ID。

j-bp19vlwm0tyigbmj****
ImageNamestring

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

testAliCloudImageName
BusinessStatusstring

迁移任务的业务状态。可能值:

  • Preparing:准备中。
  • Syncing:同步中。
  • Processing:处理中。
  • Cleaning:清理中。
Preparing
ReplicationJobRunsobject []

迁移任务运行记录。

EndTimestring

迁移任务运行的结束时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 +8小时后是控制台上显示的时间。
2019-10-04T13:35:00Z
Typestring

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

  • Manual:手动执行。

  • Schedule:定时执行或周期执行。

Schedule
StartTimestring

迁移任务运行的开始时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

说明 +8小时后是控制台上显示的时间。
2019-10-01T13:35:00Z
ImageIdstring

迁移任务生成的镜像ID。

m-o6w3gy99qf89rkga****
TargetTypestring

迁移交付的目标类型。可能值:

  • Image:迁移成功后,SMC为您的迁移源生成阿里云镜像。
  • ContainerImage:迁移成功后,SMC为您的迁移源生成Docker容器镜像。
  • TargetInstance:迁移成功后,SMC将您的迁移源直接迁移至目标实例。当您设置该参数值时,您需要同时指定InstanceId参数。
Image
JobTypeinteger

迁移任务的类型。可能值:

  • 0:服务器迁移。
  • 1:操作系统迁移。
  • 2:跨可用区迁移。
  • 3:VMware无代理迁移。
0
ResourceGroupIdstring

资源组ID。

rg-acfmw3ty5y7****
Tagsobject []

为SMC资源指定的标签。

Keystring

为SMC资源指定的标签键。N的取值范围:1~20。

一旦传入该值,可以为空字符串。最多支持64个字符,不能包含http://或者https://。

TestKey
Valuestring

为SMC资源指定的标签值。N的取值范围:1~20。

一旦传入该值,可以为空字符串。最多支持64个字符,不能包含http://或者https://。

TestValue
PageSizeinteger

每页行数。

10
RequestIdstring

请求ID。

6E1187E8-843A-4850-B97E-2F17F00D48F7
PageNumberinteger

迁移任务列表的页码。

1

示例

正常返回示例

JSON格式

{
  "TotalCount": 5,
  "ReplicationJobs": {
    "ReplicationJob": [
      {
        "Frequency": 15,
        "VpcId": "vpc-bp1vwnn14rqpyiczj****",
        "CreationTime": "2014-07-24T13:00:52Z",
        "Status": "Running",
        "ScheduledStartTime": "2019-06-04T13:35:00Z",
        "MaxNumberOfImageToKeep": 8,
        "ContainerNamespace": "testNamespace",
        "DataDisks": {
          "DataDisk": [
            {
              "Index": 1,
              "Size": 40,
              "Parts": {
                "Part": [
                  {
                    "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": {
          "SystemDiskPart": [
            {
              "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": {
          "ReplicationJobRun": [
            {
              "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": {
          "Tag": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        }
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "6E1187E8-843A-4850-B97E-2F17F00D48F7",
  "PageNumber": 1
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.UnauthorizedA required authorization for the specified action is not supplied.用户未授权操作指定的资源。
500InternalErrorAn error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.内部错误,请重试。如果多次尝试失败,请提交工单。

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

变更历史

变更时间变更内容概要操作
2023-07-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:500
  • 本页导读 (1)
文档反馈