DescribeSourceServers - - Centre de documentation Alibaba Cloud

Interroge les informations sur une ou plusieurs sources de migration.

Description de l'opération

Description

Les paramètres de requête sont utilisés comme filtres et sont combinés avec un ET logique. Si un paramètre est vide, le filtre correspondant est ignoré.

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:DescribeSourceServers

get

*SourceServer

acs:smc:{#regionId}:{#accountId}:sourceserver/{#SourceServerId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
JobId	string	Non	L'identifiant de la tâche de migration.	j-bp19vlwm0tyigbmj****
State	string	Non	L'état du serveur source. Valeurs valides : Unavailable : le serveur source est indisponible. Cela inclut les états hors ligne et en erreur. Available : le serveur source est en ligne. InUse : le serveur source est en cours de migration. Deleting : le serveur source est en cours de suppression.	Available
Name	string	Non	Le nom du serveur source. Le nom doit comporter entre 2 et 128 caractères. Il doit commencer par une lettre et ne peut pas commencer par `http://` ou `https://`. Le nom peut contenir des chiffres, des deux-points (:), des traits de soulignement (_) et des traits d'union (-). Valeur par défaut : vide.	testSourceServerName
PageNumber	integer	Non	Le numéro de page. Les pages commencent à la page 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur maximale : 50.	10
SourceId	array	Non	L'identifiant du serveur source. Vous pouvez spécifier plusieurs identifiants.	s-bp1e2fsl57knvuug****
	string	Non	L'identifiant du serveur source. Vous pouvez spécifier plusieurs identifiants.	s-bp1e2fsl57knvuug****
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfmw3ty5y7****
Tag	array<object>	Non	Les balises.
	object	Non	La balise.
Key	string	Non	La clé de la balise N. N peut être un entier compris entre 1 et 20. La clé de la balise ne peut pas être une chaîne vide. La clé de la balise peut comporter jusqu'à 64 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:` et ne peut pas contenir `http://` ou `https://`.	TestKey
Value	string	Non	La valeur de la balise N. N peut être un entier compris entre 1 et 20. La valeur de la balise peut être une chaîne vide. La valeur de la balise peut comporter jusqu'à 64 caractères. Elle ne peut pas contenir `http://` ni `https://`.	TestValue
RelatedJobType	array	Non	Le type de la tâche associée.
	string	Non	Le type de la tâche associée. Valeurs valides : Not_Related : Aucune tâche n'est associée. Server : Une tâche de migration de serveur. Os : Une tâche de migration de système d'exploitation. Cross_Zone : Une tâche de migration interzone. VMWare : Une tâche de migration VMware. Desktop : Une tâche de bureau.	Server
WorkgroupId	string	Non	L'identifiant du groupe de travail.	w-bp1ja22kdqphehlj****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
SourceServers	object
SourceServer	array<object>	Les informations sur les serveurs sources.
	array<object>	Les informations sur les serveurs sources.
CreationTime	string	The time when the source server was created.	2019-06-27T02:58:09Z
HeartbeatRate	integer	The heartbeat interval of the Server Migration Center (SMC) client. Unit: seconds.	30
State	string	The state of the source server.	InUse
DataDisks	object
DataDisk	array<object>	The data disks of the source server.
	array<object>	The data disks of the source server.
Index	integer	The index number of the data disk.	1
Size	integer	The size of the data disk. Unit: GiB.	20
Parts	object
Part	array<object>	The partitions of the data disk.
	object	The partitions of the data disk.
CanBlock	boolean	Indicates whether block replication is supported for the data disk partition.	false
SizeBytes	integer	The size of the data disk partition. Unit: bytes.	21474836480
Need	boolean	Indicates whether the data disk partition must be selected.	false
Device	string	The device ID of the data disk partition.	1_0
Path	string	The mount point of the data disk partition.	/home/data
Path	string	The mount point of the data disk.	/home/data
SystemDiskParts	object
SystemDiskPart	array<object>	The partitions of the system disk.
	object	The partitions of the system disk.
CanBlock	boolean	Indicates whether block replication is supported for the system disk partition.	true
SizeBytes	integer	The size of the system disk partition. Unit: bytes.	254803968
Need	boolean	Indicates whether the system disk partition must be selected.	true
Device	string	The device ID of the system disk partition.	0_0
Path	string	The mount point of the system disk partition.	/boot
KernelLevel	integer	The kernel level.	1
SourceId	string	The ID of the source server.	s-bp1e2fsl57knvuug****
AgentVersion	string	The version of the SMC client.	1.5.2.3
StatusInfo	string	The information about the state of the source server. This parameter is returned when the source server is in an abnormal state. The value is a JSON-formatted key-value pair. Example: `- error_code: The error code. - error_msg: The error message.`	{"error_code": "S1", "error_msg": "Rsync not found. Please install rsync."}
SystemDiskSize	integer	The size of the system disk of the source server. Unit: GiB.	40
Description	string	The description of the source server.	Server Source Imported By GotoAliyun.
ErrorCode	string	The error code returned if the source server is in an abnormal state.	SourceServer.Offline
JobId	string	The ID of the last migration task.	j-bp19vlwm0tyigbmj****
Platform	string	The operating system of the source server.	OpenSUSE
ReplicationDriver	string	The replication driver. Default value: SMT.	SMT
Name	string	The name of the source server.	SourceServerName
SystemInfo	string	The system information of the source server. The value is a JSON-formatted key-value pair that cannot exceed 1 KB in size. Example: `agent_mode: The running mode. agent_type: The running type. client_type: The client type. hostname: The hostname. ipv4: The IPv4 address. ipv6: The IPv6 address. cores: The number of CPU cores. cpu_usage: The CPU usage. memory: The memory size. memory_usage: The memory usage.`	{\"agent_mode\":\"daemon\",\"agent_type\":\"aliyun\",\"client_type\":\"\",\"cores\":\"2\",\"cpu_usage\":\"0.00\",\"hostname\":\"ixxxxxxxxxx\",\"ipv4\":\"10.0.0.1\",\"memory\":\"8.00\",\"memory_usage\":\"3.61\"}
Architecture	string	The architecture of the source server.	x86_64
ResourceGroupId	string	The ID of the resource group.	rg-acfmw3ty5y7****
Tags	object
Tag	array<object>	The tags.
	object	The tag.
Key	string	The key of tag N. N can be an integer from 1 to 20. The tag key cannot be an empty string. The tag key can be up to 64 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	TestKey
Value	string	The value of tag N. N can be an integer from 1 to 20. The tag value can be an empty string. The tag value can be up to 64 characters in length. It cannot contain `http://` or `https://`.	TestValue
Disks	object	The information about the disks.
System	object	The information about the system disk.
Size	integer	The size of the system disk of the source server. Unit: GiB. The value must be in the range of 20 to 32,768. Remarque The value of this parameter must be greater than the used space of the data disk on the source server. For example, if the 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.	100
Offset	integer	The start offset of the first partition on the system disk. Unit: bytes.	1024
Parts	object
Part	array<object>	The partitions of the system disk.
	object	The information about the partition.
CanBlock	boolean	Indicates whether block replication is supported for the system disk partition. Valid values: true: Block replication is supported for the system disk partition. false: Block replication is not supported for the system disk partition.	false
SizeBytes	integer	The size of the system disk partition. Unit: bytes.	21474836480
Path	string	The mount point of the system disk partition.	/home/data
Type	string	The type of the system disk partition. Valid values: Normal: A normal partition. System: A system partition. Boot: A boot partition.	Normal
Data	object
Data	array<object>	The information about the data disks.
	array<object>	The information about the data disk.
Size	integer	The size of the data disk of the source server. Unit: GiB.	80
Offset	integer	The start offset of the first partition on the data disk. Unit: bytes.	1024
Parts	object
Part	array<object>	The partitions of the data disk.
	object	The information about the data disk partitions.
CanBlock	boolean	Indicates whether block replication is enabled 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
SizeBytes	integer	The size of the data disk partition. Unit: bytes.	21474836480
Path	string	The mount point of the data disk partition.	/home/data
Type	string	The type of the data disk partition. Valid values: Normal: A normal partition. System: A system partition. Boot: A boot partition.	Normal
WorkgroupId	string	The ID of the workgroup.	w-bp1ja22kdqphehlj****
TotalCount	integer	Le nombre total de serveurs sources.	1
PageSize	integer	Le nombre d'entrées par page.	10
RequestId	string	L'identifiant de la requête.	410E6073-66D0-45D3-AB3E-4DC3F5E4****
PageNumber	integer	Le numéro de page.	1

Exemples

JSON format

{
  "SourceServers": {
    "SourceServer": [
      {
        "CreationTime": "2019-06-27T02:58:09Z",
        "HeartbeatRate": 30,
        "State": "InUse",
        "DataDisks": {
          "DataDisk": [
            {
              "Index": 1,
              "Size": 20,
              "Parts": {
                "Part": [
                  {
                    "CanBlock": false,
                    "SizeBytes": 21474836480,
                    "Need": false,
                    "Device": "1_0",
                    "Path": "/home/data"
                  }
                ]
              },
              "Path": "/home/data"
            }
          ]
        },
        "SystemDiskParts": {
          "SystemDiskPart": [
            {
              "CanBlock": true,
              "SizeBytes": 254803968,
              "Need": true,
              "Device": "0_0",
              "Path": "/boot"
            }
          ]
        },
        "KernelLevel": 1,
        "SourceId": "s-bp1e2fsl57knvuug****",
        "AgentVersion": "1.5.2.3",
        "StatusInfo": "{\"error_code\": \"S1\", \"error_msg\": \"Rsync not found. Please install rsync.\"}",
        "SystemDiskSize": 40,
        "Description": "Server Source Imported By GotoAliyun.",
        "ErrorCode": "SourceServer.Offline",
        "JobId": "j-bp19vlwm0tyigbmj****",
        "Platform": "OpenSUSE",
        "ReplicationDriver": "SMT",
        "Name": "SourceServerName",
        "SystemInfo": "{\\\"agent_mode\\\":\\\"daemon\\\",\\\"agent_type\\\":\\\"aliyun\\\",\\\"client_type\\\":\\\"\\\",\\\"cores\\\":\\\"2\\\",\\\"cpu_usage\\\":\\\"0.00\\\",\\\"hostname\\\":\\\"ixxxxxxxxxx\\\",\\\"ipv4\\\":\\\"10.0.0.1\\\",\\\"memory\\\":\\\"8.00\\\",\\\"memory_usage\\\":\\\"3.61\\\"}",
        "Architecture": "x86_64",
        "ResourceGroupId": "rg-acfmw3ty5y7****",
        "Tags": {
          "Tag": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        },
        "Disks": {
          "System": {
            "Size": 100,
            "Offset": 1024,
            "Parts": {
              "Part": [
                {
                  "CanBlock": false,
                  "SizeBytes": 21474836480,
                  "Path": "/home/data",
                  "Type": "Normal"
                }
              ]
            }
          },
          "Data": {
            "Data": [
              {
                "Size": 80,
                "Offset": 1024,
                "Parts": {
                  "Part": [
                    {
                      "CanBlock": false,
                      "SizeBytes": 21474836480,
                      "Path": "/home/data",
                      "Type": "Normal"
                    }
                  ]
                }
              }
            ]
          }
        },
        "WorkgroupId": "w-bp1ja22kdqphehlj****"
      }
    ]
  },
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "410E6073-66D0-45D3-AB3E-4DC3F5E4****",
  "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.