调用DescribeReplicationJobs查询一个或多个迁移任务的详细信息。
接口说明
- 请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。
- 支持迁移源的迁移目标为 Docker 容器镜像,实现低成本容器化应用迁移。关于 Docker 容器镜像详情请参见容器镜像服务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
smc:DescribeReplicationJobs | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 否 | 迁移任务的名称。 | testMigrationTaskName |
RegionId | string | 否 | 迁移源需迁入的目标阿里云地域 ID。 例如,您需要迁移源服务器至杭州,则 RegionId 为 | cn-hangzhou |
Status | string | 否 | 迁移任务的主状态。取值范围:
| Ready |
BusinessStatus | string | 否 | 迁移任务的业务状态。取值范围:
| Preparing |
PageNumber | integer | 否 | 返回结果中,迁移任务列表的页码。起始值:1。 默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。最大值:50。 默认值:10。 | 10 |
SourceId | array | 否 | 迁移源 ID 列表。N 的最大值为 50。 | |
string | 否 | 迁移源 ID 列表。N 的最大值为 50。 | s-bp1bjhkwk2j5hlbn**** | |
JobId | array | 否 | 迁移任务 ID 列表。N 的最大值:50。 | |
string | 否 | 迁移任务 ID 列表。N 的最大值:50。 | j-bp1h3d33mekxwu0n**** | |
JobType | integer | 否 | 迁移任务的类型。取值范围:
| 0 |
InstanceId | array | 否 | 实例 ID。 | |
string | 否 | 目标实例 ID。 | i-bp1f1dvfto1sigz5**** | |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfmw3ty5y7**** |
Tag | array<object> | 否 | 为 SMC 资源指定的标签。 | |
object | 否 | 为 SMC 资源指定的标签。 | ||
Key | string | 否 | 为 SMC 资源指定的标签键。N 的取值范围:1~20。 一旦传入该值,可以为空字符串。最多支持 64 个字符,不能包含 http://或者 https://。 | TestKey |
Value | string | 否 | 为 SMC 资源指定的标签值。N 的取值范围:1~20。 一旦传入该值,可以为空字符串。最多支持 64 个字符,不能包含 http://或者 https://。 | TestValue |
返回参数
示例
正常返回示例
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"
}
]
},
"Disks": {
"System": {
"Size": 100,
"LVM": false,
"DiskId": "d-2zeh4twm100qskw7z41z",
"Parts": {
"Part": [
{
"SizeBytes": 21474836480,
"Block": true,
"Path": "/boot"
}
]
}
},
"Data": {
"Data": [
{
"Size": 22548578304,
"LVM": false,
"DiskId": "d-2zeh4twm100qskw7z41z",
"Parts": {
"Part": [
{
"SizeBytes": 21474836480,
"Block": false,
"Path": "/home/data\n"
}
]
}
}
]
}
}
}
]
},
"PageSize": 10,
"RequestId": "6E1187E8-843A-4850-B97E-2F17F00D48F7",
"PageNumber": 1
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-27 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-07-28 | OpenAPI 错误码发生变更 | 查看变更详情 |