DescribeInstances - - 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	DescribeInstances	L'opération à exécuter. Définissez la valeur sur DescribeInstances.
PageNumber	Integer	No	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	No	10	Nombre d'entrées à renvoyer par page. Valeur par défaut : 10.
RegionId	String	No	cn-hangzhou	ID de région du bastion host.
InstanceStatus	String	No	RUNNING	État du bastion host. Valeurs possibles : PENDING : Le bastion host n'est pas initialisé. CREATING : Création du bastion host en cours. RUNNING : Le bastion host est en cours d'exécution. EXPIRED : Le bastion host a expiré. CREATE_FAILED : Échec de la création du bastion host. UPGRADING : Modification de la configuration du bastion host en cours. UPGRADE_FAILED : Échec de la modification de la configuration du bastion host.
ResourceGroupId	String	No	rg-acfm26ougi****	ID du groupe de ressources auquel appartient le bastion host.
InstanceId.N	String	No	2	ID du bastion host.
Tag.N.Key	String	No	test	Clé de tag du bastion host.
Tag.N.Value	String	No	testapi	Valeur de tag du bastion host.

Paramètres de réponse

Parameter	Type	Example	Description
TotalCount	Long	4	Nombre total de bastion hosts interrogés.
RequestId	String	61D36C55-AAFC-4678-8FAD-34FEF9E7182E	ID de la requête, utilisé pour localiser et résoudre les problèmes.
Instances	Array of Instance		Tableau contenant les bastion hosts interrogés.
VpcId	String	vpc-bp1c85tzgqu1bf5b****	ID du VPC (Virtual Private Cloud) auquel appartient le bastion host.
VswitchId	String	vsw-bp1xfwzzfti0kjbf****	ID du vSwitch auquel appartient le bastion host.
ImageVersion	String	3.0.0	Version de l'image du bastion host.
PlanCode	String	cloudbastion_ha	Édition du bastion host. Valeurs possibles : cloudbastion : Basic cloudbastion_ha : Enterprise
Description	String	Test an operation.	Description du bastion host.
ExpireTime	Long	1578326400000	Horodatage d'expiration du bastion host. Unité : millisecondes.
Legacy	Boolean	false	Indique si le bastion host exécute une version antérieure. Valeurs possibles : true : le bastion host exécute la version V2 ou V3.1. false : le bastion host exécute la version V3.2.
InstanceId	String	bastionhost-cn-78v1gh****	ID du bastion host.
InternetEndpoint	String	drawvxalwb-public.bastionhost.aliyuncs.com	Adresse publique d'O&M du bastion host.
RegionId	String	cn-hangzhou	ID de région du bastion host.
IntranetEndpoint	String	drawvxalwb.bastionhost.aliyuncs.com	Adresse privée d'O&M du bastion host.
StartTime	Long	1577681345000	Horodatage d'achat ou de renouvellement du bastion host. Unité : millisecondes.
ResourceGroupId	String	g-acfm26ougi****	ID du groupe de ressources auquel appartient le bastion host.
InstanceStatus	String	RUNNING	État du bastion host. Valeurs possibles : PENDING : Le bastion host n'est pas initialisé. CREATING : Création du bastion host en cours. RUNNING : Le bastion host est en cours d'exécution. EXPIRED : Le bastion host a expiré. CREATE_FAILED : Échec de la création du bastion host. UPGRADING : Modification de la configuration du bastion host en cours. UPGRADE_FAILED : Échec de la modification de la configuration du bastion host.
LicenseCode	String	bhah_ent_50_asset	Code de licence du bastion host.
PublicNetworkAccess	Boolean	true	Indique si le bastion host est accessible depuis Internet. Valeurs possibles : true : Le bastion host est accessible depuis Internet. false : Le bastion host n'est pas accessible depuis Internet.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=DescribeInstances
&PageNumber=1
&PageSize=10
&RegionId=cn-hangzhou
&InstanceStatus=RUNNING
&ResourceGroupId=rg-acfm26ougi****
&InstanceId=["2"]
&Tag=[{"Key":"test","Value":"testapi"}]
&<Common request parameters>

Exemples de réponses réussies

XML format

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

<DescribeInstancesResponse>
    <TotalCount>4</TotalCount>
    <RequestId>61D36C55-AAFC-4678-8FAD-34FEF9E7182E</RequestId>
    <Instances>
        <VpcId>vpc-bp1c85tzgqu1bf5b****</VpcId>
        <VswitchId>vsw-bp1xfwzzfti0kjbf****</VswitchId>
        <ImageVersion>3.0.0</ImageVersion>
        <PlanCode>cloudbastion_ha</PlanCode>
        <Description>Test an operation.</Description>
        <ExpireTime>1578326400000</ExpireTime>
        <Legacy>false</Legacy>
        <InstanceId>bastionhost-cn-78v1gh****</InstanceId>
        <InternetEndpoint>drawvxalwb-public.bastionhost.aliyuncs.com</InternetEndpoint>
        <RegionId>cn-hangzhou</RegionId>
        <IntranetEndpoint>drawvxalwb.bastionhost.aliyuncs.com</IntranetEndpoint>
        <StartTime>1577681345000</StartTime>
        <ResourceGroupId>g-acfm26ougi****</ResourceGroupId>
        <InstanceStatus>RUNNING</InstanceStatus>
        <LicenseCode>bhah_ent_50_asset</LicenseCode>
        <PublicNetworkAccess>true</PublicNetworkAccess>
    </Instances>
</DescribeInstancesResponse>

JSON format

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

{
  "TotalCount" : 4,
  "RequestId" : "61D36C55-AAFC-4678-8FAD-34FEF9E7182E",
  "Instances" : [ {
    "VpcId" : "vpc-bp1c85tzgqu1bf5b****",
    "VswitchId" : "vsw-bp1xfwzzfti0kjbf****",
    "ImageVersion" : "3.0.0",
    "PlanCode" : "cloudbastion_ha",
    "Description" : "Test an operation.",
    "ExpireTime" : 1578326400000,
    "Legacy" : false,
    "InstanceId" : "bastionhost-cn-78v1gh****",
    "InternetEndpoint" : "drawvxalwb-public.bastionhost.aliyuncs.com",
    "RegionId" : "cn-hangzhou",
    "IntranetEndpoint" : "drawvxalwb.bastionhost.aliyuncs.com",
    "StartTime" : 1577681345000,
    "ResourceGroupId" : "g-acfm26ougi****",
    "InstanceStatus" : "RUNNING",
    "LicenseCode" : "bhah_ent_50_asset",
    "PublicNetworkAccess" : true
  } ]
}

Codes d'erreur

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