ListHostGroups - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	ListHostGroups	Nom de l'opération à effectuer. Définissez la valeur sur ListHostGroups.
InstanceId	String	Oui	bastionhost-cn-st220aw****	ID de l'instance Bastionhost contenant les groupes d'hôtes à interroger. Remarque Appelez l'opération DescribeInstances pour obtenir l'ID de l'instance Bastionhost.
RegionId	String	Non	cn-hangzhou	ID de région de l'instance Bastionhost contenant les groupes d'hôtes à interroger. Remarque Pour plus d'informations sur la correspondance entre les ID de région et les noms de région, consultez la rubrique Régions et zones.
PageNumber	String	Non	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	String	Non	20	Nombre d'entrées à renvoyer par page. La valeur du paramètre PageSize ne doit pas dépasser 100. La valeur par défaut est 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.
HostGroupName	String	Non	Host group 1	Nom du groupe d'hôtes à interroger. Seule la correspondance exacte est prise en charge.

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

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

Paramètres de réponse

Paramètre	Type	Exemple	Description
HostGroups	Array of Item		Groupes d'hôtes renvoyés.
Comment	String	Description	Description du groupe d'hôtes.
HostGroupId	String	1	ID du groupe d'hôtes.
HostGroupName	String	Host group 1	Nom du groupe d'hôtes.
MemberCount	Integer	1	Nombre d'hôtes dans le groupe d'hôtes.
RequestId	String	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE	ID de la requête.
TotalCount	Integer	1	Nombre total de groupes d'hôtes renvoyés.

Exemples

Exemple de requête

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

Exemple de réponse réussie

Format XML

<ListHostGroupsResponse>
      <TotalCount>1</TotalCount>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <HostGroups>
            <Comment>Description</Comment>
            <MemberCount>1</MemberCount>
            <HostGroupId>1</HostGroupId>
            <HostGroupName>Host group 1</HostGroupName>
      </HostGroups>
</ListHostGroupsResponse>

Format JSON

{
	"TotalCount": "1",
	"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
	"HostGroups": [{
		"Comment": "Description",
		"HostGroupId": "1",
		"MemberCount": "1",
		"HostGroupName": "Host group 1"
	}]
}

Codes d'erreur

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