ListHosts - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListHosts	L'opération à effectuer. Définissez la valeur sur ListHosts.
InstanceId	String	Yes	bastionhost-cn-st220aw****	ID de l'instance Bastionhost contenant les hôtes à répertorier. Remarque Appelez l'opération DescribeInstances pour obtenir l'ID de l'instance Bastionhost.
RegionId	String	No	cn-hangzhou	ID de région de l'instance Bastionhost contenant les hôtes à répertorier. Remarque Pour en savoir plus sur la correspondance entre les ID de région et les noms de région, consultez Regions and zones.
PageNumber	String	No	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	String	No	20	Nombre d'entrées à renvoyer par page. La valeur du paramètre PageSize ne doit pas dépasser 100. Valeur par défaut : 20. Si vous laissez le paramètre PageSize vide, 20 entrées sont renvoyées par page par défaut. Remarque Nous vous recommandons de ne pas laisser le paramètre PageSize vide.
OSType	String	No	Linux	Système d'exploitation de l'hôte à rechercher. Valeurs possibles : Linux Windows
HostName	String	No	host	Nom de l'hôte à rechercher. Seule la correspondance exacte est prise en charge.
HostAddress	String	No	1.1.XX.XX	Endpoint de l'hôte à rechercher. Vous pouvez indiquer un nom de domaine ou une adresse IP. Seule la correspondance exacte est prise en charge.
Source	String	No	Local	Source de l'hôte à rechercher. Valeurs possibles : Local : hôte local Ecs : instance Elastic Compute Service (ECS) Rds : hôte dans un cluster dédié
SourceInstanceId	String	No	i-bp19ienyt0yax748****	ID de l'instance ECS ou de l'hôte de cluster dédié à rechercher. Seule la correspondance exacte est prise en charge.
SourceInstanceState	String	No	Normal	État de l'hôte à rechercher. Valeurs possibles : Normal : L'hôte est normal. Release : L'hôte a été libéré.
HostGroupId	String	No	1	ID du groupe d'hôtes auquel appartient l'hôte à rechercher. Remarque Appelez l'opération ListHostGroups pour obtenir l'ID du groupe d'hôtes.

Toutes les opérations API Alibaba Cloud doivent inclure des paramètres de requête communs. Pour plus d'informations sur les paramètres de requête communs, consultez Common parameters.

Pour plus d'informations sur les exemples de requêtes, consultez la section « Exemples » de cette rubrique.

Paramètres de réponse

Parameter	Type	Example	Description
Hosts	Array of Item		Hôtes répertoriés.
ActiveAddressType	String	Public	Type d'endpoint de l'hôte. Valeurs possibles : Public : endpoint public Private : endpoint interne
Comment	String	host	Description de l'hôte.
HostAccountCount	Integer	1	Nombre de comptes d'hôte.
HostId	String	1	ID de l'hôte.
HostName	String	name	Nom de l'hôte.
HostPrivateAddress	String	192.168.XX.XX	Endpoint interne de l'hôte. Vous pouvez indiquer un nom de domaine ou une adresse IP.
HostPublicAddress	String	1.1.XX.XX	Endpoint public de l'hôte. Vous pouvez indiquer un nom de domaine ou une adresse IP.
OSType	String	Linux	Système d'exploitation de l'hôte. Valeurs possibles : Linux Windows
Source	String	Local	Source de l'hôte. Valeurs possibles : Local : hôte local Ecs : instance Elastic Compute Service (ECS) Rds : hôte dans un cluster dédié
SourceInstanceId	String	i-bp19ienyt0yax748****	ID de l'instance ECS ou de l'hôte de cluster dédié répertorié. Remarque Aucune valeur n'est renvoyée pour ce paramètre si le paramètre Source est défini sur Local.
SourceInstanceState	String	Normal	État de l'hôte. Valeurs possibles : Normal : L'hôte est normal. Release : L'hôte a été libéré.
RequestId	String	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE	ID de la requête.
TotalCount	Integer	1	Nombre total d'hôtes répertoriés.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=ListHosts
&InstanceId=bastionhost-cn-st220aw****
&<Common request parameters>

Exemples de réponses réussies

XML format

<ListHostsResponse>
      <Hosts>
            <Comment>host</Comment>
            <ActiveAddressType>Public</ActiveAddressType>
            <HostPrivateAddress>192.168.XX.XX</HostPrivateAddress>
            <HostPublicAddress>1.1.XX.XX</HostPublicAddress>
            <OSType>Linux</OSType>
            <HostId>1</HostId>
            <HostAccountCount>1</HostAccountCount>
            <SourceInstanceId>i-bp19ienyt0yax748****</SourceInstanceId>
            <SourceInstanceState>Normal</SourceInstanceState>
            <HostName>name</HostName>
            <Source>Local</Source>
      </Hosts>
      <TotalCount>1</TotalCount>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
</ListHostsResponse>

JSON format

{
	"Hosts": [{
		"Comment": "host",
		"ActiveAddressType": "Public",
		"HostPrivateAddress": "192.168.XX.XX",
		"HostPublicAddress": "1.1.XX.XX",
		"OSType": "Linux",
		"HostId": "1",
		"HostAccountCount": "1",
		"SourceInstanceId": "i-bp19ienyt0yax748****",
		"SourceInstanceState": "Normal",
		"HostName": "name",
		"Source": "Local"
	}],
	"TotalCount": "1",
	"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.