DescribeNetworkInterfaces - - Centre de documentation Alibaba Cloud

Remarques sur l'utilisation

L'opération DescribeNetworkInterfaces permet d'effectuer une requête paginée en spécifiant le paramètre MaxResults ou NextToken. Lors de la première requête pour récupérer la première page de résultats, définissez MaxResults pour indiquer le nombre maximal d'entrées à retourner. La valeur retournée pour NextToken est un jeton de pagination utilisable lors de l'appel suivant afin d'obtenir une nouvelle page de résultats. Pour les requêtes ultérieures, attribuez à NextToken la valeur obtenue lors de l'appel précédent et définissez MaxResults pour limiter le nombre d'entrées retournées dans cet appel.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération via OpenAPI Explorer. Cet outil génère dynamiquement des exemples de code pour différents SDKs.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Yes	DescribeNetworkInterfaces	Opération à exécuter. Définissez la valeur sur DescribeNetworkInterfaces.
RegionId	String	Yes	cn-hangzhou	ID de région de l'ENI. Appelez l'opération DescribeRegions pour obtenir la liste la plus récente des régions.
Tag.N.Key	String	No	TestKey	Clé du tag N de l'ENI. Les valeurs valides de N vont de 1 à 20.
Tag.N.Value	String	No	TestValue	Valeur du tag N de l'ENI. Les valeurs valides de N vont de 1 à 20. Si un seul tag est spécifié pour la requête, la réponse peut afficher jusqu'à 1 000 ressources portant ce tag. Si plusieurs tags sont spécifiés, jusqu'à 1 000 ressources possédant tous ces tags peuvent être retournées. Pour interroger plus de 1 000 ENI associées à des tags spécifiques, utilisez l'opération ListTagResources.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	ID du groupe de ressources. Si ce paramètre est utilisé pour filtrer les ressources, jusqu'à 1 000 ressources appartenant au groupe spécifié sont retournées. Remarque Les ENI du groupe de ressources par défaut apparaissent toujours dans la réponse, quelle que soit la configuration de ce paramètre.
VSwitchId	String	No	vsw-bp16usj2p27htro3****	ID du vSwitch auquel l'ENI est connectée.
VpcId	String	No	vpc-bp1j7w3gc1cexjqd****	ID du Virtual Private Cloud (VPC) auquel appartient l'ENI.
PrimaryIpAddress	String	No	192.168..	Adresse IPv4 privée principale de l'ENI.
SecurityGroupId	String	No	sg-bp144yr32sx6ndw****	ID du groupe de sécurité auquel appartient l'ENI secondaire. Spécifiez ce paramètre pour rechercher les détails des ENI secondaires à partir d'un ID de groupe de sécurité. Pour obtenir les détails des ENI principales via un ID de groupe de sécurité, appelez l'opération DescribeInstances en renseignant le paramètre `SecurityGroupId`.
NetworkInterfaceName	String	No	test-eni-name	Nom de l'ENI.
Type	String	No	Secondary	Type de l'ENI. Valeurs valides : Primary Secondary Par défaut, ce paramètre est vide, ce qui entraîne l'interrogation simultanée des ENI principales et secondaires.
InstanceId	String	No	i-bp1e2l6djkndyuli****	ID de l'instance à laquelle l'ENI est attachée.
ServiceManaged	Boolean	No	true	Indique si l'utilisateur de l'ENI est un service Alibaba Cloud ou un distributeur.
Status	String	No	Available	État de l'ENI. Valeurs valides : Available : l'ENI est disponible. Attaching : l'ENI est en cours d'attachement à une instance. InUse : l'ENI est attachée à une instance. Detaching : l'ENI est en cours de détachement d'une instance. Deleting : l'ENI est en cours de suppression. Ce paramètre est vide par défaut, ce qui signifie que les ENI de tous les états sont interrogées.
PageNumber	Integer	No	1	Remarque Ce paramètre est obsolète. Nous vous recommandons d'utiliser MaxResults ou NextToken pour la pagination.
PageSize	Integer	No	100	Remarque Ce paramètre n'est plus utilisé. Privilégiez les paramètres MaxResults ou NextToken pour effectuer une requête paginée.
NextToken	String	No	AAAAAdDWBF2****	Jeton de pagination utilisé lors de la requête suivante pour récupérer une nouvelle page de résultats. Ce paramètre n'est pas nécessaire pour la première requête. Pour les appels suivants, attribuez-lui la valeur du jeton obtenu lors de la requête précédente via `NextToken`. Pour plus d'informations sur l'analyse des réponses de cette opération, consultez la section « Remarques sur l'utilisation » de cette rubrique.
MaxResults	Integer	No	50	Nombre maximal d'entrées par page. Valeurs valides : de 10 à 500. Valeur par défaut : Si ce paramètre est omis ou défini sur une valeur inférieure à 10, la valeur par défaut est 10. Si la valeur spécifiée dépasse 500, la valeur par défaut de 500 s'applique.
PrivateIpAddress.N	String	No	192.168..	Adresse IPv4 privée secondaire N de l'ENI. Les valeurs valides de N vont de 1 à 100.
NetworkInterfaceId.N	String	No	eni-bp125p95hhdhn3ot****	ID de l'ENI N. Les valeurs valides de N vont de 1 à 100.
Ipv6Address.N	String	No	2408:4321:180:1701:94c7:bc38:3bfa:****	Adresse IPv6 N de l'ENI. Les valeurs valides de N vont de 1 à 100.

Paramètres de réponse

Paramètre	Type	Exemple	Description
NextToken	String	AAAAAdDWBF2****	Jeton de pagination. Il peut être utilisé lors de la prochaine requête pour récupérer une nouvelle page de résultats.
PageSize	Integer	1	Nombre d'entrées par page. Remarque Ce paramètre sera supprimé ultérieurement. Nous vous conseillons d'utiliser NextToken et MaxResults pour la pagination.
PageNumber	Integer	1	Numéro de la page. Remarque Ce paramètre sera retiré à l'avenir. Privilégiez l'usage de NextToken et MaxResults pour les requêtes paginées.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	ID de la requête.
TotalCount	Integer	2	Nombre total d'ENI retournées. Remarque Si vous utilisez les paramètres `MaxResults` et `NextToken` pour une requête paginée, la valeur du paramètre de réponse `TotalCount` n'est pas valide.
NetworkInterfaceSets	Array of NetworkInterfaceSet		Détails des ENI.
NetworkInterfaceSet
CreationTime	String	2019-12-25T12:31:31Z	Heure de création de l'ENI.
VpcId	String	vpc-bp1j7w3gc1cexjqd****	ID du VPC auquel appartient l'ENI.
Type	String	Secondary	Type de l'ENI.
Status	String	Available	État de l'ENI.
NetworkInterfaceTrafficMode	String	Standard	Mode de communication de l'ENI. Valeurs valides : Standard : utilise le mode de communication TCP. HighPerformance : utilise le mode RDMA (Remote Direct Memory Access) avec l'interface Elastic RDMA (ERI) activée. Remarque La valeur HighPerformance n'est possible que si l'ENI est attachée à une instance optimisée RDMA c7re située dans la zone K de Pékin.
NetworkInterfaceName	String	my-eni-name	Nom de l'ENI.
MacAddress	String	00:16:3e:12::	Adresse MAC (Media Access Control) de l'ENI.
QueuePairNumber	Integer	0	Remarque Ce paramètre est en avant-première sur invitation uniquement et n'est pas accessible publiquement.
NetworkInterfaceId	String	eni-bp125p95hhdhn3ot****	ID de l'ENI.
ServiceID	Long	12345678910	ID du distributeur auquel appartient l'ENI.
InstanceId	String	i-bp1e2l6djkndyuli****	ID de l'instance à laquelle l'ENI est liée. Remarque Aucun ID d'instance n'est retourné si l'ENI est gérée et contrôlée par d'autres services Alibaba Cloud.
OwnerId	String	123456****	ID du compte propriétaire de l'ENI.
ServiceManaged	Boolean	true	Précise si l'utilisateur de l'ENI est un service Alibaba Cloud ou un distributeur.
VSwitchId	String	vsw-bp16usj2p27htro3****	ID du vSwitch associé à l'ENI.
Description	String	DescriptionTest	Description de l'ENI.
ResourceGroupId	String	rg-2ze88m67qx5z****	ID du groupe de ressources auquel appartient l'ENI.
ZoneId	String	cn-hangzhou-e	ID de zone de l'ENI.
PrivateIpAddress	String	172.17..	Adresse IP privée de l'ENI.
QueueNumber	Integer	8	Nombre de files d'attente prises en charge par l'ENI. Pour une ENI secondaire à l'état InUse dont le nombre de files d'attente n'a jamais été modifié, la valeur correspond au nombre par défaut pris en charge par le type d'instance. Si le nombre de files d'attente de l'ENI secondaire a été modifié, la nouvelle valeur est retournée. Une valeur vide est retournée pour une ENI secondaire à l'état Available si son nombre de files d'attente n'a jamais été ajusté. Dans le cas d'une ENI principale, le système retourne le nombre de files d'attente par défaut correspondant au type d'instance.
PrivateIpSets	Array of PrivateIpSet		Adresses IP privées de l'ENI.
PrivateIpSet
PrivateIpAddress	String	172.17..	Adresse IP privée de l'ENI.
Primary	Boolean	true	Indique si l'adresse IP est l'adresse IP privée principale. Valeurs valides : true : il s'agit de l'adresse IP privée principale. false : il s'agit d'une adresse IP privée secondaire.
AssociatedPublicIp	Object		Détails concernant l'Elastic IP Address (EIP) associée à l'ENI.
PublicIpAddress	String	116.62..	EIP de l'ENI.
AllocationId	String	null	Remarque Ce paramètre fait l'objet d'une avant-première sur invitation et n'est pas disponible publiquement.
Ipv6Sets	Array of Ipv6Set		Adresses IPv6 attribuées à l'ENI.
Ipv6Set
Ipv6Address	String	2408:4321:180:1701:94c7:bc38:3bfa:****	Adresse IPv6 attribuée à l'ENI.
Ipv4PrefixSets	Array of Ipv4PrefixSet		Préfixes IPv4 attribués à l'ENI.
Ipv4PrefixSet
Ipv4Prefix	String	192 168.**.0/28	Préfixe IPv4 attribué à l'ENI.
Ipv6PrefixSets	Array of Ipv6PrefixSet		Préfixes IPv6 attribués à l'ENI.
Ipv6PrefixSet
Ipv6Prefix	String	2001:db8:1234:1a00:****::/80	Préfixes IPv6 attribués à l'ENI.
Tags	Array of Tag		Tags de l'ENI.
Tag
TagValue	String	TestValue	Valeur du tag de l'ENI.
TagKey	String	TestKey	Clé du tag de l'ENI.
SecurityGroupIds	Array of String	sg-bp18kz60mefsicfg****	IDs des groupes de sécurité auxquels appartient l'ENI.
AssociatedPublicIp	Object		EIP associée à l'adresse IP privée secondaire de l'ENI.
PublicIpAddress	String	116.62..	EIP de l'ENI.
AllocationId	String	null	Remarque Ce paramètre est en avant-première sur invitation uniquement et n'est pas accessible publiquement.
Attachment	Object		Remarque Ce paramètre fait l'objet d'une avant-première sur invitation et n'est pas disponible publiquement.
DeviceIndex	Integer	0	Remarque Ce paramètre est en avant-première sur invitation uniquement et n'est pas accessible publiquement.
InstanceId	String	null	Remarque Ce paramètre est en avant-première sur invitation uniquement et n'est pas accessible publiquement.
TrunkNetworkInterfaceId	String	null	Remarque Ce paramètre est en avant-première sur invitation uniquement et n'est pas accessible publiquement.
NetworkCardIndex	Integer	0	Index de la carte réseau. Ce paramètre ne contient aucune valeur si l'ENI est à l'état Available ou si aucun index de carte réseau n'a été spécifié lors de son attachement. Si l'ENI est à l'état InUse et qu'un index de carte réseau a été défini lors de l'attachement, cette valeur est retournée.
DeleteOnRelease	Boolean	true	Indique si l'ENI doit être libérée lors de la libération de l'instance associée. Valeurs valides : true false

Exemples

Exemples de requêtes

https://ecs.aliyuncs.com/?Action=DescribeNetworkInterfaces
&RegionId=cn-hangzhou
&PrivateIpAddress.1=192.168.**.**
&PrivateIpAddress.2=192.168.**.**
&NextToken=AAAAAdDWBF2****
&<Common request parameters>

Exemples de réponses réussies

Format XML

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

<DescribeNetworkInterfacesResponse>
    <NextToken>AAAAAdDWBF2****</NextToken>
    <PageSize>1</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <TotalCount>2</TotalCount>
    <NetworkInterfaceSets>
        <CreationTime>2019-12-25T12:31:31Z</CreationTime>
        <VpcId>vpc-bp1j7w3gc1cexjqd****</VpcId>
        <Type>Secondary</Type>
        <Status>Available</Status>
        <NetworkInterfaceTrafficMode>Standard</NetworkInterfaceTrafficMode>
        <NetworkInterfaceName>my-eni-name</NetworkInterfaceName>
        <MacAddress>00:16:3e:12:**:**</MacAddress>
        <QueuePairNumber>0</QueuePairNumber>
        <NetworkInterfaceId>eni-bp125p95hhdhn3ot****</NetworkInterfaceId>
        <ServiceID>12345678910</ServiceID>
        <InstanceId>i-bp1e2l6djkndyuli****</InstanceId>
        <OwnerId>123456****</OwnerId>
        <ServiceManaged>true</ServiceManaged>
        <VSwitchId>vsw-bp16usj2p27htro3****</VSwitchId>
        <Description>DescriptionTest</Description>
        <ResourceGroupId>rg-2ze88m67qx5z****</ResourceGroupId>
        <ZoneId>cn-hangzhou-e</ZoneId>
        <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
        <QueueNumber>8</QueueNumber>
        <PrivateIpSets>
            <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
            <Primary>true</Primary>
            <AssociatedPublicIp>
                <PublicIpAddress>116.62.**.**</PublicIpAddress>
                <AllocationId>null</AllocationId>
            </AssociatedPublicIp>
        </PrivateIpSets>
        <Ipv6Sets>
            <Ipv6Address>2408:4321:180:1701:94c7:bc38:3bfa:****</Ipv6Address>
        </Ipv6Sets>
        <Ipv4PrefixSets>
            <Ipv4Prefix>192.168.**.0/28</Ipv4Prefix>
        </Ipv4PrefixSets>
        <Ipv6PrefixSets>
            <Ipv6Prefix>2001:db8:1234:1a00:****::/80</Ipv6Prefix>
        </Ipv6PrefixSets>
        <Tags>
            <TagValue>TestValue</TagValue>
            <TagKey>TestKey</TagKey>
        </Tags>
        <SecurityGroupIds>sg-bp18kz60mefsicfg****</SecurityGroupIds>
        <AssociatedPublicIp>
            <PublicIpAddress>116.62.**.**</PublicIpAddress>
            <AllocationId>null</AllocationId>
        </AssociatedPublicIp>
        <Attachment>
            <DeviceIndex>0</DeviceIndex>
            <InstanceId>null</InstanceId>
            <TrunkNetworkInterfaceId>null</TrunkNetworkInterfaceId>
            <NetworkCardIndex>0</NetworkCardIndex>
            <DeleteOnRelease>true</DeleteOnRelease>
        </Attachment>
    </NetworkInterfaceSets>
</DescribeNetworkInterfacesResponse>

Format JSON

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

{
  "NextToken" : "AAAAAdDWBF2****",
  "PageSize" : 1,
  "PageNumber" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount" : 2,
  "NetworkInterfaceSets" : [ {
    "CreationTime" : "2019-12-25T12:31:31Z",
    "VpcId" : "vpc-bp1j7w3gc1cexjqd****",
    "Type" : "Secondary",
    "Status" : "Available",
    "NetworkInterfaceTrafficMode" : "Standard",
    "NetworkInterfaceName" : "my-eni-name",
    "MacAddress" : "00:16:3e:12:**:**",
    "QueuePairNumber" : 0,
    "NetworkInterfaceId" : "eni-bp125p95hhdhn3ot****",
    "ServiceID" : 12345678910,
    "InstanceId" : "i-bp1e2l6djkndyuli****",
    "OwnerId" : "123456****",
    "ServiceManaged" : true,
    "VSwitchId" : "vsw-bp16usj2p27htro3****",
    "Description" : "DescriptionTest",
    "ResourceGroupId" : "rg-2ze88m67qx5z****",
    "ZoneId" : "cn-hangzhou-e",
    "PrivateIpAddress" : "172.17.**.**",
    "QueueNumber" : 8,
    "PrivateIpSets" : [ {
      "PrivateIpAddress" : "172.17.**.**",
      "Primary" : true,
      "AssociatedPublicIp" : {
        "PublicIpAddress" : "116.62.**.**",
        "AllocationId" : "null"
      }
    } ],
    "Ipv6Sets" : [ {
      "Ipv6Address" : "2408:4321:180:1701:94c7:bc38:3bfa:****"
    } ],
    "Ipv4PrefixSets" : [ {
      "Ipv4Prefix" : "192.168.**.0/28"
    } ],
    "Ipv6PrefixSets" : [ {
      "Ipv6Prefix" : "2001:db8:1234:1a00:****::/80"
    } ],
    "Tags" : [ {
      "TagValue" : "TestValue",
      "TagKey" : "TestKey"
    } ],
    "SecurityGroupIds" : [ "sg-bp18kz60mefsicfg****" ],
    "AssociatedPublicIp" : {
      "PublicIpAddress" : "116.62.**.**",
      "AllocationId" : "null"
    },
    "Attachment" : {
      "DeviceIndex" : 0,
      "InstanceId" : "null",
      "TrunkNetworkInterfaceId" : "null",
      "NetworkCardIndex" : 0,
      "DeleteOnRelease" : "true"
    }
  } ]
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
400	MissingParameter	%s	Un paramètre obligatoire n'est pas spécifié.
400	UnsupportedParameter	%s	Un paramètre spécifié n'est pas pris en charge.
400	InvalidParameter	%s	Valeur de paramètre invalide.
400	InvalidInstanceID.Malformed	%s	Format InstanceId invalide.
400	InvalidOperation.InvalidEcsState	%s	Cette opération ne peut pas être effectuée sur l'instance dans son état actuel.
400	InvalidOperation.InvalidEniState	%s	Cette opération ne peut pas être effectuée sur l'ENI dans son état actuel.
400	InvalidOperation.DetachPrimaryEniNotAllowed	%s	L'ENI principale ne peut pas être détachée de l'instance.
400	Forbidden.RegionId	%s	Le service est momentanément indisponible dans cette région.
400	InvalidRegionId.MalFormed	The specified parameter RegionId is not valid.	Valeur RegionId invalide.
403	InvalidUserType.NotSupported	%s	Votre compte ne prend pas en charge cette opération.
403	Abs.InvalidAccount.NotFound	%s	Votre compte Alibaba Cloud est introuvable ou votre paire AccessKey a expiré.
403	Forbidden.NotSupportRAM	%s	Les utilisateurs Resource Access Management (RAM) ne disposent pas des permissions nécessaires pour effectuer cette opération.
403	Forbidden.SubUser	%s	Vous n'avez pas accès à cette ressource. Contactez le propriétaire du compte Alibaba Cloud.
403	MaxEniCountExceeded	%s	Le nombre maximal d'ENI pouvant être gérées est dépassé.
403	EniPerInstanceLimitExceeded	%s	Le nombre maximal d'ENI pouvant être attachées à l'instance est dépassé.
403	InvalidOperation.AvailabilityZoneMismatch	%s	L'opération est invalide.
403	InvalidOperation.VpcMismatch	%s	L'opération est invalide. Vérifiez si le VPC correspond aux autres paramètres.
403	SecurityGroupInstanceLimitExceed	%s	Le nombre maximal d'instances dans le groupe de sécurité est dépassé.
403	InvalidSecurityGroupId.NotVpc	%s	ID de groupe de sécurité invalide. Le type de réseau du groupe spécifié n'est pas VPC.
403	InvalidOperation.InvalidEniType	%s	Cette opération ne peut pas être effectuée sur ce type d'ENI.
403	InvalidVpc.Empty	%s	Aucun vSwitch n'existe dans le VPC spécifié. Pour plus d'informations, consultez la valeur du placeholder %s dans le message d'erreur.
404	InvalidEcsId.NotFound	%s	L'ID de l'instance est introuvable.
404	InvalidEniId.NotFound	%s	L'ID de l'ENI est introuvable.
404	InvalidVSwitchId.NotFound	%s	L'ID du vSwitch spécifié est introuvable.
404	InvalidSecurityGroupId.NotFound	%s	L'ID du groupe de sécurité spécifié est introuvable.

Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur du service.