DescribeInstances - - Centre de documentation Alibaba Cloud

Consulte les détails d'une ou plusieurs instances.

Description de l'opération

Fréquence d'appel de l'API : 800 appels par seconde.

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.

ens:DescribeInstances

list

*Instance.

acs:ens:*:{#accountId}:instance/{#InstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
EnsRegionId	string	Non	L'identifiant de la région.	cn-beijing-cmcc
InstanceId	string	Non	L'identifiant de l'instance.	i-5iqczfxps7csjrxeca****
EnsRegionIds	string	Non	La liste des identifiants de zone edge. Ce paramètre est un tableau JSON formaté qui contient jusqu'à 100 identifiants séparés par des virgules (,).	["cn-suzhou-telecom","cn-chengdu-telecom"]
InstanceIds	string	Non	La liste des identifiants d'instance. Ce paramètre est un tableau JSON formaté qui contient jusqu'à 100 identifiants séparés par des virgules (,).	["i-5iqczfxps7csjrxeca07**", "i-5iqczfxps7csjrxeca07**"]
InstanceName	string	Non	Le nom de l'instance.	TestName
ImageId	string	Non	L'identifiant de l'image.	centos_6_08_64_20G_alibase_****
PageNumber	integer	Non	Le numéro de page de la liste des états d'instance. La valeur commence à 1.	1
PageSize	string	Non	Le nombre d'entrées par page pour une requête paginée. Valeur maximale : 100.	10
Status	string	Non	L'état de l'instance. Valeurs valides : Running : en cours d'exécution. Stopped : arrêté. Expired : expiré.	Running
OrderByParams	string	Non	Le paramètre de tri au format JSON.	{
EnsServiceId	string	Non	L'identifiant d'Edge Node Service. Vous pouvez utiliser cet identifiant pour consulter les instances créées sous le service edge.	ens-20190730202316s****
InstanceResourceType	string	Non	Le type de filtre. Valeurs valides :	EnsService
SearchKey	string	Non	Le mot-clé de recherche. Prend en charge des paramètres tels que ip, InstanceName et InstanceId.	Joshua
NetworkId	string	Non	L'identifiant du réseau.	n-2zeuphj08tt7q3brd****
VSwitchId	string	Non	L'identifiant du vSwitch.	vsw-2zeh0r1pabwtg6wcs****
SecurityGroupId	string	Non	L'identifiant du groupe de sécurité.	sg-5kyicq2kfcapxrdds6tar7jqb
IntranetIp	string	Non	L'adresse IP interne.	47.100.XX.XX
Tags	array<object>	Non	Les balises de ressource. Cette opération ne renvoie pas d'informations sur les balises. Utilisez ce paramètre en combinaison avec les API de la catégorie des balises.
	object	Non	L'ensemble de balises de l'instance. Cette opération ne renvoie pas d'informations sur les balises. Utilisez ce paramètre en combinaison avec les API de la catégorie des balises.
Key	string	Non	La clé de balise de l'instance. Valeurs valides de N : 1 à 20.	tag
Value	string	Non	La valeur de balise de l'instance. Valeurs valides de N : 1 à 20.	2
InstanceType	string	Non	Le type d'instance.	ens.se1.tiny
ServiceStatus	array	Non	L'état commercial de l'instance, qui ne représente pas l'état de fonctionnement réel de l'instance.
	string	Non	L'état du service de l'instance. Cela ne reflète pas l'état de fonctionnement réel de l'instance. Expiré Arriérés (paiement en retard)	Expired
EipAddresses	array	Non	La liste des adresses EIP utilisées pour filtrer les instances.
	string	Non	La liste des adresses EIP utilisées pour filtrer les instances.	120.XX.XX.10
VpdId	string	Non	L'identifiant du réseau VPD.	vpd-5s7xxxxxxx
VpdVSwitchId	string	Non	L'identifiant du vSwitch VPD.	vsw-5s7xxxxxxx

Éléments de réponse

Élément	Type	Description	Exemple
	object
Code	integer	Le code métier renvoyé. Une valeur de 0 indique un succès.	0
PageSize	integer	Le nombre d'entrées par page spécifié dans la requête.	60
PageNumber	integer	Le numéro de page de la liste des instances.	1
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Le nombre total d'instances renvoyées.	2
Instances	object
Instance	array<object>	Un tableau d'objets InstanceAttributesType contenant les informations sur les instances.
	array<object>	Schéma de la réponse.
CreationTime	string	L'heure de création de l'instance. L'heure est au format UTC et utilise le format ISO 8601 : `yyyy-MM-ddTHH:mm:ssZ`.	2019-07-26T06:40:43Z
Status	string	L'état de l'instance. Valeurs valides : Running : l'instance est en cours d'exécution. Expired : l'instance a expiré. Stopped : l'instance est arrêtée.	Running
SpecName	string	Le type d'instance.	ens.sn1.stiny
InstanceTypeFamily	string	La famille de types d'instances. Valeurs valides : `x86_vm` : calcul x86 `x86_pm` : bare metal x86 `x86_bmi` : instance bare metal x86 `x86_bm` : bare metal avec Smart NIC `pc_bmi` : instance bare metal hétérogène `pc_vm` : machine virtuelle hétérogène `arm_bmi` : calcul ARM	x86_vm
InstanceResourceType	string	Le type de ressource de l'instance. Valeurs valides : EnsInstance : une instance autonome. EnsService : une instance de service de périphérie. BuildMachine : une machine de création d'image. EnsPostPaidInstance : une instance autonome à l'usage.	EnsService
HostName	string	Le nom d'hôte de l'instance. Un point (.) ou un trait d'union (-) ne peut pas être le premier ou le dernier caractère, et ne peut pas être utilisé de manière consécutive. Pour les instances Windows, le nom d'hôte doit comporter de 2 à 15 caractères, composés de lettres, de chiffres et de traits d'union (-). Il ne peut pas contenir de points (.) ni être composé uniquement de chiffres. Pour les autres types d'instances (comme Linux), le nom d'hôte doit comporter de 2 à 64 caractères. Vous pouvez utiliser des points (.) pour séparer le nom en segments. Chaque segment peut être composé de lettres, de chiffres et de traits d'union (-).	testHostName
InstanceId	string	L'identifiant de l'instance.	i-instanc****
InternetMaxBandwidthIn	integer	La bande passante publique entrante maximale. Unité : Mbit/s.	40
InternetMaxBandwidthOut	integer	La bande passante publique sortante maximale. Unité : Mbit/s.	100
EnsRegionId	string	L'identifiant de la région de l'instance.	cn-hangzhou-telecom
Cpu	string	Le nombre de cœurs vCPU.	2
ExpiredTime	string	L'heure d'expiration. L'heure est au format UTC et utilise le format ISO 8601 : `yyyy-MM-ddTHH:mm:ssZ`.	2119-07-13T02:38:57Z
InstanceName	string	Le nom de l'instance.	i-5itef0f28t17bcdw9deu6meub
Disk	integer	La taille totale des disques. Unité : Mio.	71680
OSName	string	Le nom de l'image.	centos 6.8 x86_64
Memory	integer	La taille de la mémoire. Unité : Mo.	2048
ImageId	string	L'identifiant de l'image.	m-****
DataDisk	object
DataDisk	array<object>	Les informations sur les disques de données.
	object	Les détails d'un disque de données.
device_type	string	La catégorie du disque. Valeurs valides : file : disque local. pangu : disque cloud haute efficacité. local_hdd : disque dur local.	pangu
disk_type	string	Le type de disque cloud ou de disque local. Valeurs valides : system : disque système. data : disque de données.	system
Size	integer	La taille du disque. Unité : Mio.	51200
DiskName	string	Le nom du disque.	DiskName
uuid	string	L'UUID.	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	La taille du disque. Unité : Mio.	20480
DiskId	string	L'identifiant du disque.	d-5ip4c2dhmas0vjd5u1r****
Category	string	La catégorie du disque cloud ou du disque local. Valeurs valides : file : disque local. pangu : disque cloud haute efficacité. local_hdd : disque HDD local.	file
name	string	Le nom du disque.	name
DiskSize	integer	La taille du disque. Unité : Gio.	100
EncryptKeyId	string	L'identifiant de la clé KMS utilisée pour le disque cloud.	0e478b7a-4262-4802-b8cb-00d3fxxxxx
Encrypted	boolean	Indique si le disque cloud est chiffré.	true
PublicIpAddresses	object
PublicIpAddress	array<object>	Les informations sur les adresses IP publiques.
	object	Les informations sur les adresses IP publiques.
Ip	string	L'adresse IP.	119.147.xx.xx
GateWay	string	La passerelle.	119.147.xx.xx
Isp	string	Le FAI.	unicom
PrivateIpAddresses	object
PrivateIpAddress	array<object>	Les informations sur les adresses IP privées de l'instance.
	object
Ip	string	L'adresse IP.	119.147.xx.xx
GateWay	string	La passerelle.	119.147.xx.xx
Isp	string	Le FAI.	cmcc
SecurityGroupIds	object
SecurityGroupId	array	L'identifiant du groupe de sécurité.
	string	L'identifiant du groupe de sécurité.	sg-5kyicq2kfcapxrdds6ta****
InnerIpAddress	object
IpAddress	array	L'adresse IP privée de l'instance.
	string	Une adresse IP privée de l'instance.	10.170.xx.xx
PublicIpAddress	object
IpAddress	array	L'adresse IP publique.
	string	Une adresse IP publique.	119.147.xx.xx
SystemDisk	object	Les détails du disque système.
device_type	string	La catégorie du disque. Valeurs valides : file : disque local. pangu : disque cloud haute efficacité. local_hdd : disque dur local.	pangu
disk_type	string	Le type du disque cloud ou du disque local. Valeurs valides : system : disque système. data : disque de données.	system
Size	integer	La taille du disque. Unité : Mio.	51200
DiskName	string	Le nom du disque.	DiskName
uuid	string	L'UUID.	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	La capacité du disque. Unité : Mio.	20480
DiskId	string	L'identifiant du disque.	d-5ip4c2dhmas0rn7rt0p9****
Category	string	La catégorie du disque cloud ou du disque local. Valeurs valides : file : disque local. pangu : disque cloud haute efficacité. local_hdd : disque dur local.	file
name	string	Le nom du disque.	DiskName
NetworkAttributes	object	Les informations réseau.
NetworkId	string	L'identifiant du réseau.	n-2zeuphj08tt7q3brd****
VSwitchId	string	L'identifiant du VSwitch.	vsw-2zeh0r1pabwtg6wcs****
PrivateIpAddress	object
IpAddress	array	Les informations sur les adresses IP privées de l'instance.
	string	L'adresse IP privée de l'instance. Vous ne pouvez spécifier qu'une seule adresse IP privée. L'adresse IP doit être une adresse disponible dans le bloc CIDR du VSwitch spécifié (VSwitchId).	172.17..
Tags	object
Tags	array<object>	Les balises de l'instance. Important Cette opération ne renvoie pas d'informations sur les balises. Pour récupérer les balises, vous devez appeler une API de balisage dédiée.
	object	Les informations de balise. Important Cette opération ne renvoie pas les informations de balise. Pour récupérer les balises, vous devez appeler une API de balisage dédiée.
TagValue	string	La valeur de la balise.	value1
TagKey	string	La clé de la balise.	key1
AutoReleaseTime	string	L'heure à laquelle l'instance est automatiquement libérée.	2023-06-28T14:38:52Z
SpotStrategy	string	La stratégie d'enchères pour l'instance spot.	NoSpot
KeyPairName	string	Le nom de la paire de clés.	TestKeyPairName
NetworkInterfaces	object
NetworkInterfaces	array<object>	Une liste d'interfaces réseau élastiques.
	array<object>	Les détails d'une interface réseau élastique.
Type	string	Le type de l'interface réseau élastique. Valeurs valides : `Primary` : l'interface réseau principale. `Secondary` : l'interface réseau secondaire.	Primary
MacAddress	string	L'adresse MAC de l'interface réseau élastique.	00:16:XXX:XXX:60:0a
PrimaryIpAddress	string	L'adresse IP privée principale.	10.XXX.XXX.25
NetworkInterfaceId	string	L'identifiant de l'interface réseau élastique.	eni-53afk8a0t5lklbi8m7j8iczdg
PrivateIpSets	object
PrivateIpSet	array<object>	Une collection d'objets PrivateIpSet.
	object	Une collection d'objets PrivateIpSet.
PrivateIpAddress	string	L'adresse IP privée.	192.XXX.XXX.130
Primary	boolean	Indique si l'adresse IP est l'adresse IP privée principale. Valeurs valides : `true` : l'adresse IP est l'adresse IP privée principale. `false` : l'adresse IP est une adresse IP privée secondaire.	true
Ipv6Sets	object
Ipv6Set	array<object>	Une collection d'adresses IPv6 attribuées à l'interface réseau élastique.
	object	Une collection d'adresses IPv6 attribuées à l'interface réseau élastique.
Ipv6Address	string	L'adresse IPv6 attribuée à l'interface réseau élastique.	2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6
VpdVSwitchId	string		vsw-5s7xxxxxxx
VpdId	string		vpd-5s7xxxxxxx
ServiceStatus	string	L'état du service de l'instance, et non son état d'exécution.	Expired
DeletionProtection	boolean

Exemples

JSON format

{
  "Code": 0,
  "PageSize": 60,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 2,
  "Instances": {
    "Instance": [
      {
        "CreationTime": "2019-07-26T06:40:43Z",
        "Status": "Running",
        "SpecName": "ens.sn1.stiny",
        "InstanceTypeFamily": "x86_vm",
        "InstanceResourceType": "EnsService",
        "HostName": "testHostName",
        "InstanceId": "i-instanc****",
        "InternetMaxBandwidthIn": 40,
        "InternetMaxBandwidthOut": 100,
        "EnsRegionId": "cn-hangzhou-telecom",
        "Cpu": "2",
        "ExpiredTime": "2119-07-13T02:38:57Z",
        "InstanceName": "i-5itef0f28t17bcdw9deu6meub",
        "Disk": 71680,
        "OSName": "centos 6.8 x86_64",
        "Memory": 2048,
        "ImageId": "m-****",
        "DataDisk": {
          "DataDisk": [
            {
              "device_type": "pangu",
              "disk_type": "system",
              "Size": 51200,
              "DiskName": "DiskName",
              "uuid": "5431f898-1323-4e64-8ce1-6cad50ed****",
              "storage": 20480,
              "DiskId": "d-5ip4c2dhmas0vjd5u1r****",
              "Category": "file",
              "name": "name",
              "DiskSize": 100,
              "EncryptKeyId": "0e478b7a-4262-4802-b8cb-00d3fxxxxx",
              "Encrypted": true
            }
          ]
        },
        "PublicIpAddresses": {
          "PublicIpAddress": [
            {
              "Ip": "119.147.xx.xx",
              "GateWay": "119.147.xx.xx",
              "Isp": "unicom"
            }
          ]
        },
        "PrivateIpAddresses": {
          "PrivateIpAddress": [
            {
              "Ip": "119.147.xx.xx",
              "GateWay": "119.147.xx.xx",
              "Isp": "cmcc"
            }
          ]
        },
        "SecurityGroupIds": {
          "SecurityGroupId": [
            "sg-5kyicq2kfcapxrdds6ta****"
          ]
        },
        "InnerIpAddress": {
          "IpAddress": [
            "10.170.xx.xx"
          ]
        },
        "PublicIpAddress": {
          "IpAddress": [
            "119.147.xx.xx"
          ]
        },
        "SystemDisk": {
          "device_type": "pangu",
          "disk_type": "system",
          "Size": 51200,
          "DiskName": "DiskName",
          "uuid": "5431f898-1323-4e64-8ce1-6cad50ed****",
          "storage": 20480,
          "DiskId": "d-5ip4c2dhmas0rn7rt0p9****",
          "Category": "file",
          "name": "DiskName"
        },
        "NetworkAttributes": {
          "NetworkId": "n-2zeuphj08tt7q3brd****",
          "VSwitchId": "vsw-2zeh0r1pabwtg6wcs****",
          "PrivateIpAddress": {
            "IpAddress": [
              "172.17.**.**"
            ]
          }
        },
        "Tags": {
          "Tags": [
            {
              "TagValue": "value1",
              "TagKey": "key1"
            }
          ]
        },
        "AutoReleaseTime": "2023-06-28T14:38:52Z",
        "SpotStrategy": "NoSpot",
        "KeyPairName": "TestKeyPairName",
        "NetworkInterfaces": {
          "NetworkInterfaces": [
            {
              "Type": "Primary",
              "MacAddress": "00:16:XXX:XXX:60:0a",
              "PrimaryIpAddress": "10.XXX.XXX.25",
              "NetworkInterfaceId": "eni-53afk8a0t5lklbi8m7j8iczdg",
              "PrivateIpSets": {
                "PrivateIpSet": [
                  {
                    "PrivateIpAddress": "192.XXX.XXX.130",
                    "Primary": true
                  }
                ]
              },
              "Ipv6Sets": {
                "Ipv6Set": [
                  {
                    "Ipv6Address": "2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6"
                  }
                ]
              },
              "VpdVSwitchId": "vsw-5s7xxxxxxx",
              "VpdId": "vpd-5s7xxxxxxx"
            }
          ]
        },
        "ServiceStatus": "Expired",
        "DeletionProtection": false
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.