ListHostAccounts - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de simplicité, nous vous recommandons d’appeler cette opération dans OpenAPI Explorer. Celui-ci 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	ListHostAccounts	Opération à effectuer. Définissez la valeur sur ListHostAccounts.
InstanceId	String	Oui	bastionhost-cn-st220aw****	ID du bastion host dans lequel vous souhaitez interroger les comptes de l’hôte spécifié. Remarque Appelez l’opération DescribeInstances pour obtenir l’ID du bastion host.
RegionId	String	Non	cn-hangzhou	ID de région du bastion host dans lequel vous souhaitez interroger les comptes de l’hôte spécifié. 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.
HostId	String	Oui	1	ID de l’hôte spécifié dont vous souhaitez interroger les comptes. Remarque Appelez l’opération ListHosts pour obtenir l’ID de l’hôte.
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. Valeur maximale : 100. Valeur par défaut : 20. Si vous laissez ce paramètre vide, 20 entrées sont renvoyées par page. Remarque Nous vous recommandons de ne pas laisser ce paramètre vide.
HostAccountName	String	Non	abc	Nom du compte d’hôte à interroger. Le nom peut comporter jusqu’à 128 caractères. Seule la correspondance exacte est prise en charge.
ProtocolName	String	Non	SSH	Protocole utilisé par l’hôte dont vous souhaitez interroger les comptes. Valeurs valides : SSH RDP

Paramètres de réponse

Paramètre	Type	Exemple	Description
TotalCount	Integer	1	Nombre total de comptes d’hôte interrogés.
RequestId	String	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE	ID de la requête.
HostAccounts	Array of Item		Tableau contenant les comptes d’hôte interrogés.
HasPassword	Boolean	true	Indique si un mot de passe est configuré pour le compte d’hôte. Valeurs valides : true : Un mot de passe est configuré pour le compte d’hôte. false : Aucun mot de passe n’est configuré pour le compte d’hôte.
PrivateKeyFingerprint	String	fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a::	Empreinte de la clé privée du compte d’hôte.
ProtocolName	String	SSH	Protocole utilisé par l’hôte. Valeurs valides : SSH RDP
HostAccountName	String	abc	Nom du compte d’hôte.
HostAccountId	String	1	ID du compte d’hôte.
HostId	String	1	ID de l’hôte.
HostShareKeyId	String	1	ID de la clé partagée.
HostShareKeyName	String	name	Nom de la clé partagée.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=ListHostAccounts
&InstanceId=bastionhost-cn-st220aw****
&RegionId=cn-hangzhou
&HostId=1
&PageNumber=1
&PageSize=20
&HostAccountName=abc
&ProtocolName=SSH
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListHostAccountsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
    <HostAccounts>
        <HasPassword>true</HasPassword>
        <PrivateKeyFingerprint>fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**</PrivateKeyFingerprint>
        <ProtocolName>SSH</ProtocolName>
        <HostAccountName>abc</HostAccountName>
        <HostAccountId>1</HostAccountId>
        <HostId>1</HostId>
        <HostShareKeyId>1</HostShareKeyId>
        <HostShareKeyName>name</HostShareKeyName>
    </HostAccounts>
</ListHostAccountsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostAccounts" : [ {
    "HasPassword" : true,
    "PrivateKeyFingerprint" : "fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**",
    "ProtocolName" : "SSH",
    "HostAccountName" : "abc",
    "HostAccountId" : "1",
    "HostId" : "1",
    "HostShareKeyId" : "1",
    "HostShareKeyName" : "name"
  } ]
}

Codes d’erreur

Code d’état HTTP	Code d’erreur	Message d’erreur	Description
400	InvalidParameter	The argument is invalid.	Un ou plusieurs paramètres ne sont pas valides.
500	InternalError	An unknown error occurred.	Une erreur inconnue s’est produite.

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