DescribeReplicationJobs - - Centre de documentation Alibaba Cloud

Obtient les détails d'une ou plusieurs tâches de migration.

Description de l'opération

Opérations API

Les paramètres de requête sont utilisés comme filtres et sont combinés à l'aide d'un ET logique. Si vous ne spécifiez pas de paramètre, le filtre correspondant n'est pas appliqué.
Vous pouvez migrer une source vers une image de conteneur Docker pour une conteneurisation d'applications à faible coût. Pour plus d'informations sur les images de conteneur Docker, consultez Container Registry.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

smc:DescribeReplicationJobs

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Name	string	Non	Le nom de la tâche de migration.	testMigrationTaskName
RegionId	string	Non	L'identifiant de la région Alibaba Cloud de destination vers laquelle vous souhaitez migrer la source. Par exemple, si vous souhaitez migrer un serveur source vers la région Chine (Hangzhou), définissez RegionId sur `cn-hangzhou`. Vous pouvez appeler DescribeRegions pour consulter la liste la plus récente des régions Alibaba Cloud.	cn-hangzhou
Status	string	Non	L'état principal de la tâche de migration. Valeurs valides : Ready : la tâche n'est pas démarrée. Running : la tâche est en cours d'exécution. Stopped : la tâche est en pause. InError : une erreur s'est produite. Finished : la tâche est terminée. Waiting : la tâche est en attente. Expired : la tâche a expiré. Deleting : la tâche est en cours de suppression.	Ready
BusinessStatus	string	Non	L'état métier de la tâche de migration. Valeurs valides : Preparing : la tâche est en cours de préparation. Syncing : les données sont en cours de synchronisation. Processing : la tâche est en cours de traitement. Cleaning : la tâche est en cours de nettoyage.	Preparing
PageNumber	integer	Non	Le numéro de page de la liste des tâches de migration. La valeur commence à 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer sur chaque page pour une requête paginée. Valeur maximale : 50. Valeur par défaut : 10.	10
SourceId	array	Non	Les identifiants des sources de migration. Vous pouvez spécifier jusqu'à 50 identifiants de sources de migration.	s-bp1e2fsl57knvuug****
	string	Non	Les identifiants des sources de migration. Vous pouvez spécifier jusqu'à 50 identifiants de sources de migration.	s-bp1bjhkwk2j5hlbn****
JobId	array	Non	Les identifiants des tâches de migration. Vous pouvez spécifier jusqu'à 50 identifiants de tâches de migration.	j-bp19vlwm0tyigbmj****
	string	Non	Les identifiants des tâches de migration. Vous pouvez spécifier jusqu'à 50 identifiants de tâches de migration.	j-bp1h3d33mekxwu0n****
JobType	integer	Non	Le type de la tâche de migration. Valeurs valides : 0 : migration de serveur. 1 : migration de système d'exploitation. 2 : migration interzone. 3 : migration VMware sans agent.	0
InstanceId	array	Non	L'identifiant de l'instance.
	string	Non	L'identifiant de l'instance de destination.	i-bp1f1dvfto1sigz5****
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfmw3ty5y7****
Tag	array<object>	Non	Les balises de la ressource SMC.
	object	Non	Les balises de la ressource SMC.
Key	string	Non	La clé de la balise N spécifiée pour la ressource SMC. Valeurs valides de N : 1 à 20. Ce paramètre peut être une chaîne vide. La clé de la balise peut comporter jusqu'à 64 caractères et ne peut pas contenir http:// ou https://.	TestKey
Value	string	Non	La valeur de la balise N spécifiée pour la ressource SMC. Valeurs valides de N : 1 à 20. Ce paramètre peut être une chaîne vide. La valeur de la balise peut comporter jusqu'à 64 caractères et ne peut pas contenir http:// ou https://.	TestValue

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalCount	integer	Le nombre total de tâches de migration.	5
ReplicationJobs	object
ReplicationJob	array<object>	Une collection de détails des tâches de migration.
	array<object>	Une collection de détails des tâches de migration.
Frequency	integer	The interval at which an incremental migration task is automatically run. Unit: hours. Valid values: 1 to 168.	15
VpcId	string	The ID of the VPC for which an Express Connect circuit or a VPN Gateway is configured.	vpc-bp1vwnn14rqpyiczj****
CreationTime	string	The time when the migration task was created.	2014-07-24T13:00:52Z
Status	string	The main status of the migration task. Valid values: Ready: The task is not started. Running: The task is running. Stopped: The task is paused. InError: An error occurred. Finished: The task is complete. Waiting: The task is waiting. Expired: The task has expired. Deleting: The task is being deleted.	Running
ScheduledStartTime	string	The time when the migration task is scheduled to run. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. This parameter must meet the following requirements: The time must be later than the current time and within 30 days from the current time. If you leave this parameter empty, SMC does not start the migration task. In this case, you must call the StartReplicationJob operation to start the task.	2019-06-04T13:35:00Z
MaxNumberOfImageToKeep	integer	The maximum number of images that can be retained for an incremental migration task. Valid values: 1 to 10.	8
ContainerNamespace	string	The namespace of the Docker container.	testNamespace
DataDisks	object
DataDisk	array<object>	The data disks of the destination Alibaba Cloud Elastic Compute Service (ECS) instance.
	array<object>	The data disks of the destination Alibaba Cloud ECS instance.
Index	integer	The index number of the data disk.	1
Size	integer	The size of the data disk. Unit: GiB.	40
Parts	object
Part	array<object>	The information about the data disk partitions.
	object	The information about the data disk partitions.
SizeBytes	integer	The size of the data disk partition. Unit: bytes.	21474836480
Block	boolean	Indicates whether block replication is enabled for the partition.	true
Device	string	The device ID of the data disk partition.	0_1
StatusInfo	string	The details of the migration status.	statusinfo
InstanceRamRole	string	The name of the instance RAM role.	SMCAdmin
SystemDiskSize	integer	The size of the system disk of the destination Alibaba Cloud ECS instance.	40
Description	string	The description of the migration task.	This is my migration task.
ReplicationParameters	string	The parameters of the replication driver.	BandWidthLimit:0
ErrorCode	string	The error code of the migration task.	InternalError
ValidTime	string	The time when the migration task expires. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Remarque The time displayed in the console is in the UTC+8 time zone.	2019-06-08T14:40:52Z
NetMode	integer	The network mode used for the migration.	0
ContainerTag	string	The tag of the Docker image.	CentOS:v1
LicenseType	string	The license type of the migration task. Valid values: An empty value indicates no license. BYOL: Bring Your Own License.	BYOL
Name	string	The name of the migration task.	testMigrationTaskName
ImageId	string	The ID of the destination image that is created from the migration task.	m-o6w3gy99qf89rkga****
Progress	number	The overall progress of the migration task.	100
RunOnce	boolean	Indicates whether the task is a one-time or incremental migration task. Valid values: true: The task is a one-time migration task. The task is run only once after it is created. false: The task is an incremental migration task. After the task is created, it is automatically run at the interval specified by the `Frequency` parameter.	true
LaunchTemplateId	string	The ID of the launch template.	lt-launchtemplateid
ContainerRepository	string	The Docker image repository.	testRepository
InstanceId	string	The ID of the destination instance.	i-bp1ff25rzvnul6kr****
SystemDiskParts	object
SystemDiskPart	array<object>	The information about the system disk partitions.
	object	The information about the system disk partitions.
SizeBytes	integer	The size of the system disk partition. Unit: bytes.	254803968
Block	boolean	Indicates whether block replication is enabled for the system disk partition.	true
Device	string	The device ID of the system disk partition.	0_1
InstanceType	string	The instance type of the intermediate instance.	ecs.sn1ne.large
SourceId	string	The ID of the migration source.	s-bp1e2fsl57knvuug****
LaunchTemplateVersion	string	The version of the launch template.	1
RegionId	string	The ID of the destination Alibaba Cloud region to which you want to migrate the source.	cn-hangzhou
TransitionInstanceId	string	The ID of the intermediate instance.	i-bp1ff25rzvnul6kr****
EndTime	string	The time when the migration task was completed. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Remarque The time displayed in the console is in the UTC+8 time zone.	2019-06-04T16:00:52Z
StartTime	string	The time when the migration task started. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Remarque The time displayed in the console is in the UTC+8 time zone.	2019-06-04T14:40:52Z
VSwitchId	string	The ID of the vSwitch in the specified VPC.	vsw-bp1ddbrxdlrcbim46****
JobId	string	The ID of the migration task.	j-bp19vlwm0tyigbmj****
ImageName	string	The name of the destination image that is created from the migration task.	testAliCloudImageName
BusinessStatus	string	The business status of the migration task. Valid values: Preparing: The task is being prepared. Syncing: Data is being synchronized. Processing: The task is being processed. Cleaning: The task is being cleared.	Preparing
ReplicationJobRuns	object
ReplicationJobRun	array<object>	The running records of the migration task.
	object	The running records of the migration task.
EndTime	string	The time when the migration task run ended. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Remarque The time displayed in the console is in the UTC+8 time zone.	2019-10-04T13:35:00Z
Type	string	The execution mode of the migration task. Valid values: Manual: The task is manually run. Schedule: The task is run at a scheduled time or at a specific interval.	Schedule
StartTime	string	The time when the migration task run started. The time is specified in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Remarque The time displayed in the console is in the UTC+8 time zone.	2019-10-01T13:35:00Z
ImageId	string	The ID of the image generated by the migration task.	m-o6w3gy99qf89rkga****
TargetType	string	The type of the migration destination. Valid values: Image: After the migration is complete, SMC generates an Alibaba Cloud image for the migration source. ContainerImage: After the migration is complete, SMC generates a Docker container image for the migration source. TargetInstance: After the migration is complete, SMC migrates the migration source to a destination instance. If you set the value to TargetInstance, you must also specify the InstanceId parameter.	Image
JobType	integer	The type of the migration task. Valid values: 0: server migration. 1: operating system migration. 2: cross-zone migration. 3: agentless VMware migration.	0
ResourceGroupId	string	The ID of the resource group.	rg-acfmw3ty5y7****
Tags	object
Tag	array<object>	The tags of the SMC resource.
	object	The tags of the SMC resource.
Key	string	The key of tag N that is specified for the SMC resource. Valid values of N: 1 to 20. This parameter can be an empty string. The tag key can be up to 64 characters in length and cannot contain http:// or https://.	TestKey
Value	string	The value of tag N that is specified for the SMC resource. Valid values of N: 1 to 20. This parameter can be an empty string. The tag value can be up to 64 characters in length and cannot contain http:// or https://.	TestValue
Disks	object	The disk information.
System	object	The system disk information.
Size	integer	The size of the source system disk. Unit: GiB. Valid values: 20 to 32768. Remarque The value of this parameter must be greater than the used space of the source system disk. For example, if the source system disk is 500 GiB in size and 100 GiB of the space is used, the value of this parameter must be greater than 100.	100
LVM	boolean	Indicates whether LVM is used. Valid values: true: LVM is used. false: LVM is not used.	false
DiskId	string	The system disk ID.	d-2zeh4twm100qskw7z41z
Parts	object
Part	array<object>	The system disk partition information.
	object	The system disk partition information.
SizeBytes	integer	The size of the system disk partition. Unit: bytes.	21474836480
Block	boolean	Indicates whether to enable block replication for the system disk partition. Valid values: true: Block replication is enabled for the system disk partition. false: Block replication is not enabled for the system disk partition.	true
Path	string	The path of the system disk partition.	/boot
Data	object
Data	array<object>	The data disk information.
	array<object>	The data disk information.
Size	integer	The size of the data disk of the destination Alibaba Cloud ECS instance. Unit: GiB. Valid values: 20 to 32768. Remarque The value of this parameter must be greater than the used space of the source data disk. For example, if the source data disk is 500 GiB in size and 100 GiB of the space is used, the value of this parameter must be greater than 100.	22548578304
LVM	boolean	Indicates whether LVM is used. Valid values: true: LVM is used. false: LVM is not used.	false
DiskId	string	The data disk ID.	d-2zeh4twm100qskw7z41z
Parts	object
Part	array<object>	The data disk partition information.
	object	The data disk partition information.
SizeBytes	integer	The size of the data disk partition. Unit: bytes.	21474836480
Block	boolean	Indicates whether to enable block replication for the data disk partition. Valid values: true: Block replication is enabled for the data disk partition. false: Block replication is not enabled for the data disk partition.	false
Path	string	The path of the data disk partition.	/home/data
WorkgroupId	string	The ID of the workgroup.	w-bp1ja22kdqphehlj****
PageSize	integer	Le nombre d'entrées par page.	10
RequestId	string	L'identifiant de la requête.	6E1187E8-843A-4850-B97E-2F17F00D48F7
PageNumber	integer	Le numéro de page de la liste des tâches de migration.	1

Exemples

JSON format

{
  "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"
                    }
                  ]
                }
              }
            ]
          }
        },
        "WorkgroupId": "w-bp1ja22kdqphehlj****"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "6E1187E8-843A-4850-B97E-2F17F00D48F7",
  "PageNumber": 1
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
500	InternalError	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.
403	Forbidden.Unauthorized	A required authorization for the specified action is not supplied.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.