DescribeEipAddresses - Elastic IP Address - Centre de documentation Alibaba Cloud

Consulte les adresses IP élastiques (EIP) créées dans une région spécifiée.

Description de l'opération

Cette opération récupère les informations sur les EIP créées dans une région spécifiée, y compris la bande passante maximale, la méthode de facturation et le type d'instance actuellement associée à chaque EIP. Si vous effectuez fréquemment des paginations profondes ou des sauts de page, le code d'erreur Throttling.DeepPageSkip peut être renvoyé. Réduisez la fréquence des requêtes ou utilisez une pagination séquentielle.

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.

vpc:DescribeEipAddresses

list

*Address

acs:vpc:{#regionId}:{#accountId}:eip/*

vpc:tag

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de l'EIP.	cn-hangzhou
IncludeReservationData	boolean	Non	Indique s'il faut inclure les données d'abonnement qui n'ont pas encore pris effet. Valeurs valides :	false
Status	string	Non	L'état de l'EIP. Valeurs valides :	Available
EipAddress	string	Non	L'adresse IP de l'EIP à interroger.	47.75.XX.XX
AllocationId	string	Non	L'identifiant de l'instance EIP à interroger.	eip-2zeerraiwb7ujxscd****
SegmentInstanceId	string	Non	L'identifiant d'instance du groupe d'EIP contiguës.	eipsg-t4nr90yik5oy38xdy****
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel l'EIP appartient.	rg-acfmxazb4pcdvf****
PageNumber	integer	Non	Le numéro de page de la liste. Valeur par défaut : 1.	10
PageSize	integer	Non	Le nombre d'entrées par page dans une requête paginée. Valeur maximale : 100. Valeur par défaut : 10.	10
ISP	string	Non	Le type de ligne. Valeurs valides :	BGP
Filter.1.Key	string	Non	La clé de filtre pour l'interrogation des ressources. La valeur doit être CreationStartTime, qui spécifie l'heure de début de création de la ressource.	CreationStartTime
Filter.2.Key	string	Non	La clé de filtre pour l'interrogation des ressources. La valeur doit être CreationEndTime, qui spécifie l'heure de fin de création de la ressource.	CreationEndTime
Filter.1.Value	string	Non	La valeur de filtre pour l'interrogation des ressources. Spécifiez la valeur en UTC au format `YYYY-MM-DDThh:mmZ`.	2023-01-01T01:00Z
Filter.2.Value	string	Non	La valeur de filtre pour l'interrogation des ressources. Spécifiez la valeur en UTC au format `YYYY-MM-DDThh:mmZ`.	2023-01-06T02:00Z
LockReason	string	Non	Le type de verrouillage. Valeurs valides :	financial
AssociatedInstanceType	string	Non	Le type d'instance de ressource cloud à associer. Valeurs valides :	EcsInstance
AssociatedInstanceId	string	Non	L'identifiant d'instance de la ressource cloud.	i-2zebb08phyccdvf****
ChargeType	string	Non	La méthode de facturation de l'EIP. Valeurs valides :	PostPaid
DryRun	boolean	Non	Indique si un test à blanc uniquement doit être effectué. Valeurs valides :	false
EipName	string	Non	Le nom de l'EIP.	EIP-01
Tag	array<object>	Non	Les balises utilisées pour filtrer les EIP.
	object	Non	Les balises utilisées pour filtrer les EIP.
Key	string	Non	La clé de balise. Vous pouvez spécifier jusqu'à 20 clés de balise. La clé de balise ne peut pas être une chaîne vide.	FinanceDept
Value	string	Non	La valeur de balise. Vous pouvez spécifier jusqu'à 20 valeurs de balise. La valeur de balise peut être une chaîne vide.	FinanceJoshua
SecurityProtectionEnabled	boolean	Non	Indique si Anti-DDoS (Enhanced) est activé. Valeurs valides :	false
PublicIpAddressPoolId	string	Non	L'identifiant du pool d'adresses IP auquel l'EIP à interroger appartient.	pippool-2vc0kxcedhquybdsz****
ServiceManaged	boolean	Non	Indique si l'instance est une instance gérée. Valeurs valides :	false

Éléments de réponse

Élément	Type	Description	Exemple
	object	La liste des informations renvoyées.
PageSize	integer	Le nombre d'entrées par page.	10
RequestId	string	L'identifiant de la requête.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumber	integer	Le numéro de la page actuelle.	10
TotalCount	integer	Le nombre total d'entrées.	1
EipAddresses	object
EipAddress	array<object>	Les détails de l'EIP.
	array<object>	Les détails de l'EIP.
ReservationActiveTime	string	L'heure d'activation du renouvellement au format `YYYY-MM-DDThh:mm:ssZ`.	2021-05-23T16:00:00Z
Status	string	L'état de l'EIP.	Available
ReservationOrderType	string	Le type de commande de renouvellement.	RENEWCHANGE
AllocationTime	string	L'heure de création de l'EIP au format `YYYY-MM-DDThh:mm:ssZ`.	2021-04-23T01:37:38Z
Netmode	string	Le type de réseau. La valeur est public, ce qui indique Internet.	public
ChargeType	string	La méthode de facturation de l'EIP. Valeurs valides :	PostPaid
Description	string	La description de l'EIP.	abc
Mode	string	Le mode d'association. Valeurs valides :	NAT
SegmentInstanceId	string	L'identifiant d'instance du groupe d'EIP contiguës.	eipsg-t4nr90yik5oy38xd****
ReservationInternetChargeType	string	Le type de facturation du renouvellement.	PayByBandwidth
BandwidthPackageId	string	L'identifiant de l'instance de bande passante partagée à laquelle l'EIP est ajoutée.	cbwp-bp1ego3i4j07ccdvf****
IpAddress	string	L'adresse IP de l'EIP.	47.75.XX.XX
Bandwidth	string	La bande passante maximale de l'EIP. Unité : Mbps.	5
ReservationBandwidth	string	La bande passante de renouvellement. Unité : Mbps.	12
EipBandwidth	string	La bande passante de l'EIP avant son ajout à une instance de bande passante partagée ou après sa suppression de celle-ci. Unité : Mbps.	101
Name	string	Le nom de l'EIP.	EIP-01
PrivateIpAddress	string	L'adresse IP privée de l'interface réseau élastique (ENI) secondaire à laquelle l'EIP est associée.	192.168.XX.XX
InstanceRegionId	string	L'identifiant de la région de la ressource actuellement associée à l'EIP.	cn-hangzhou
DeletionProtection	boolean	Indique si la protection contre la suppression est activée.	true
InstanceId	string	L'identifiant de l'instance actuellement associée à l'EIP.	i-bp15zckdt37cdvf****
SecondLimited	boolean	Indique si la limitation de bande passante secondaire est configurée.	false
InstanceType	string	Le type de l'instance actuellement associée à l'EIP.	EcsInstance
HDMonitorStatus	string	Indique si la surveillance à la seconde est activée pour l'EIP.	false
RegionId	string	L'identifiant de la région de l'EIP.	cn-hangzhou
BandwidthPackageBandwidth	string	La bande passante de l'instance de bande passante partagée à laquelle l'EIP est ajoutée. Unité : Mbps.	50
ServiceManaged	integer	Indique si l'instance est une instance gérée. Valeurs valides :	0
ExpiredTime	string	L'heure d'expiration au format `YYYY-MM-DDThh:mm:ssZ`.	2021-05-23T02:00:00Z
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmxazcdxs****
AllocationId	string	L'identifiant de l'instance de l'EIP.	eip-2zeerraiwb7ujcdvf****
InternetChargeType	string	La méthode de facturation de l'EIP.	PayByBandwidth
BusinessStatus	string	Le statut commercial de l'instance EIP.	Normal
BandwidthPackageType	string	Le type de bande passante. Seul CommonBandwidthPackage (bande passante partagée) est renvoyé.	CommonBandwidthPackage
HasReservationData	string	Indique si des données de renouvellement existent.	false
ISP	string	Le type de ligne.	BGP
OperationLocks	object
LockReason	array<object>	Les détails du verrouillage.
	object	Les détails du verrouillage.
LockReason	string	Le type de verrouillage.	financial
Tags	object
Tag	array<object>	La liste des balises associées à l'EIP.
	object	La liste des balises associées à l'EIP.	"Tag": [ { "Value": "000", "Key": "yyy" }, { "Value": "111","Key": "kkk" }
Key	string	La clé de balise de l'EIP.	KeyTest
Value	string	La valeur de balise de l'EIP.	ValueTest
SecurityProtectionTypes	object
SecurityProtectionType	array	Le niveau de protection de sécurité.
	string	Le niveau de protection de sécurité.	AntiDDoS_Enhanced
PublicIpAddressPoolId	string	L'identifiant du pool d'adresses IP auquel l'EIP appartient.	pippool-2vc0kxcedhquybdsz****
VpcId	string	L'identifiant du VPC pour lequel la fonction de passerelle IPv4 est activée et qui se trouve dans la même région que l'EIP.	vpc-bp15zckdt37pq72zv****
Zone	string	La zone de l'EIP.	ap-southeast-1-lzdvn-cb
BizType	string	Le type d'activité de l'EIP.	CloudBox
ServiceID	integer	L'identifiant du compte géré du service cloud.	18726XXXXXXX

Exemples

JSON format

{
  "PageSize": 10,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber": 10,
  "TotalCount": 1,
  "EipAddresses": {
    "EipAddress": [
      {
        "ReservationActiveTime": "2021-05-23T16:00:00Z",
        "Status": "Available",
        "ReservationOrderType": "RENEWCHANGE",
        "AllocationTime": "2021-04-23T01:37:38Z",
        "Netmode": "public",
        "ChargeType": "PostPaid",
        "Description": "abc",
        "Mode": "NAT",
        "SegmentInstanceId": "eipsg-t4nr90yik5oy38xd****",
        "ReservationInternetChargeType": "PayByBandwidth",
        "BandwidthPackageId": "cbwp-bp1ego3i4j07ccdvf****",
        "IpAddress": "47.75.XX.XX",
        "Bandwidth": "5",
        "ReservationBandwidth": "12",
        "EipBandwidth": "101",
        "Name": "EIP-01",
        "PrivateIpAddress": "192.168.XX.XX",
        "InstanceRegionId": "cn-hangzhou",
        "DeletionProtection": true,
        "InstanceId": "i-bp15zckdt37cdvf****",
        "SecondLimited": false,
        "InstanceType": "EcsInstance",
        "HDMonitorStatus": "false",
        "RegionId": "cn-hangzhou",
        "BandwidthPackageBandwidth": "50",
        "ServiceManaged": 0,
        "ExpiredTime": "2021-05-23T02:00:00Z",
        "ResourceGroupId": "rg-acfmxazcdxs****",
        "AllocationId": "eip-2zeerraiwb7ujcdvf****",
        "InternetChargeType": "PayByBandwidth",
        "BusinessStatus": "Normal",
        "BandwidthPackageType": "CommonBandwidthPackage",
        "HasReservationData": "false",
        "ISP": "BGP",
        "OperationLocks": {
          "LockReason": [
            {
              "LockReason": "financial"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "KeyTest",
              "Value": "ValueTest"
            }
          ]
        },
        "SecurityProtectionTypes": {
          "SecurityProtectionType": [
            "AntiDDoS_Enhanced"
          ]
        },
        "PublicIpAddressPoolId": "pippool-2vc0kxcedhquybdsz****",
        "VpcId": "vpc-bp15zckdt37pq72zv****",
        "Zone": "ap-southeast-1-lzdvn-cb",
        "BizType": "CloudBox",
        "ServiceID": 0
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	InvalidIAssociatedInstanceType.ValueNotSupported	The specified value of AssociatedInstanceType is not supported.
400	InvalidChargeType.ValueNotSupported	The specified ChargeType is not supported.
400	InvalidAliuid	User Id is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.
400	InstanceType.Invalid	InstanceType is not null
400	InstanceIdLength.Exceed	InstanceId length is exceed
400	InvalidTagKey	The tag keys are not valid.
400	InvalidTagValue	The tag values are not valid.
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	Throttling.DeepPageSkip	Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination.
404	InvalidFilterValue	The specified FilterValue is not supported.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.
404	InvalidFilterKey.NotFound	The specified Filterkey is not supported.
404	InvalidLockReason.NotFound	The specified LockReason is not found

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

Notes de version

Consultez Notes de version pour la liste complète.