DescribeEipAddresses - - Centre de documentation Alibaba Cloud

Remarques sur l'utilisation

Appelez cette opération pour interroger des informations sur les EIP dans une région spécifiée, y compris la bande passante maximale, les méthodes de facturation et les instances associées.

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	DescribeEipAddresses	L'opération à exécuter. Définissez la valeur sur DescribeEipAddresses.
RegionId	String	Yes	cn-hangzhou	L'ID de région de l'EIP. Appelez l'opération DescribeRegions pour interroger la liste des régions la plus récente.
IncludeReservationData	Boolean	No	false	Indique s'il faut renvoyer des informations sur les commandes en attente. Valeurs possibles : false (valeur par défaut) true
Status	String	No	Available	Le statut de l'EIP. Valeurs possibles : Associating Unassociating InUse Available Releasing
EipAddress	String	No	47.75.XX.XX	L'adresse IP de l'EIP à interroger. Saisissez jusqu'à 50 adresses IP d'EIP. Séparez les adresses IP par des virgules (,). Remarque Si EipAddress et AllocationId sont tous deux spécifiés, saisissez jusqu'à 50 adresses IP d'EIP dans EipAddress, et jusqu'à 50 ID d'EIP dans AllocationId.
AllocationId	String	No	eip-2zeerraiwb7ujxscd****	L'ID de l'EIP à interroger. Saisissez jusqu'à 50 ID d'EIP. Séparez les ID par des virgules (,). Remarque Si EipAddress et AllocationId sont tous deux définis, saisissez jusqu'à 50 ID d'EIP dans AllocationId, et jusqu'à 50 adresses IP d'EIP dans EipAddress.
SegmentInstanceId	String	No	eipsg-t4nr90yik5oy38xdy****	L'ID du groupe d'EIP contiguës.
ResourceGroupId	String	No	rg-acfmxazb4pcdvf****	L'ID du groupe de ressources auquel appartient l'EIP.
PageNumber	Integer	No	10	Le numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	No	10	Le nombre d'entrées par page. Valeur maximale : 100. Valeur par défaut : 10.
ISP	String	No	BGP	Le type de ligne. Valeurs possibles : BGP (par défaut) : lignes BGP (Multi-ISP). Toutes les régions prennent en charge les EIP BGP (Multi-ISP). BGP_PRO : lignes BGP (Multi-ISP) Pro. Seules les régions suivantes prennent en charge les lignes BGP (Multi-ISP) Pro : Chine (Hong Kong), Singapour, Japon (Tokyo), Malaisie (Kuala Lumpur), Philippines (Manille), Indonésie (Jakarta) et Thaïlande (Bangkok). Pour plus d'informations sur BGP (Multi-ISP) et BGP (Multi-ISP) Pro, consultez Types de lignes EIP. Si vous êtes autorisé à utiliser la bande passante mono-opérateur, choisissez également l'une des valeurs suivantes : ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2 : China Mobile L2 Si vos services sont déployés dans China East 1 Finance, ce paramètre est obligatoire et vous devez définir la valeur sur BGP_FinanceCloud.
Filter.1.Key	String	No	CreationStartTime	La clé de filtre utilisée pour interroger les ressources. Définissez la valeur sur CreationStartTime, qui correspond à l'heure à laquelle le système a commencé à créer la ressource.
Filter.2.Key	String	No	CreationEndTime	La clé de filtre utilisée pour interroger les ressources. Définissez la valeur sur CreationEndTime, qui correspond à l'heure à laquelle le système a terminé la création de la ressource.
Filter.1.Value	String	No	2023-01-01T01:00Z	La valeur de filtre utilisée pour interroger les ressources. Spécifiez l'heure au format ISO 8601 `YYYY-MM-DDThh:mmZ`. L'heure doit être en UTC.
Filter.2.Value	String	No	2023-01-06T02:00Z	La valeur de filtre utilisée pour interroger les ressources. Spécifiez l'heure au format ISO 8601 `YYYY-MM-DDThh:mmZ`. L'heure doit être en UTC.
LockReason	String	No	financial	La raison du verrouillage de l'EIP. Valeurs possibles : financial security
AssociatedInstanceType	String	No	EcsInstance	Le type de ressource cloud à associer à l'EIP. Valeurs possibles : EcsInstance (par défaut) : une instance Elastic Compute Service (ECS) dans un réseau privé virtuel (VPC) SlbInstance : une instance Server Load Balancer (SLB) dans un VPC Nat : une passerelle NAT HaVip : une adresse IP virtuelle haute disponibilité (HAVIP) NetworkInterface : une carte réseau secondaire (ENI) IpAddress : une adresse IP Remarque Vous ne pouvez associer qu'une seule EIP à chaque instance ECS, instance SLB, HAVIP ou adresse IP. Vous pouvez associer plusieurs EIP à chaque passerelle NAT. Le nombre d'EIP que vous pouvez associer à une carte réseau secondaire dépend du mode d'association. Pour plus d'informations, consultez Présentation des EIP.
AssociatedInstanceId	String	No	i-2zebb08phyccdvf****	L'ID de l'instance.
ChargeType	String	No	PostPaid	La méthode de facturation de l'EIP. Valeurs possibles : PostPaid : paiement à l'utilisation PrePaid : abonnement
DryRun	Boolean	No	false	Indique s'il faut effectuer uniquement un test à blanc, sans envoyer la requête réelle. Valeurs possibles : true : effectue uniquement un test à blanc. Le système vérifie la requête pour détecter d'éventuels problèmes, notamment les valeurs de paramètres manquantes, la syntaxe de requête incorrecte et les limites de service. Si la requête échoue au test à blanc, un message d'erreur est renvoyé. Si la requête réussit le test à blanc, le code d'erreur `DryRunOperation` est renvoyé. false (valeur par défaut) : effectue un test à blanc et envoie la requête. Si la requête réussit le test à blanc, un code d'état HTTP 2xx est renvoyé et l'opération est exécutée.
EipName	String	No	EIP-01	Le nom de l'EIP. Le nom doit comporter entre 1 et 128 caractères et peut contenir des lettres, des chiffres, des traits de soulignement (_) et des traits d'union (-). Le nom doit commencer par une lettre.
Tag.N.Key	String	No	FinanceDept	La clé du tag N ajouté à la ressource. Vous pouvez spécifier au maximum 20 clés de tag. La clé de tag ne peut pas être une chaîne vide. La clé de tag peut comporter au maximum 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.
Tag.N.Value	String	No	FinanceJoshua	La valeur du tag N à ajouter à la ressource. Vous pouvez spécifier au maximum 20 valeurs de tag. La valeur de tag peut être une chaîne vide. La valeur de tag peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir les caractères `http://` ou `https://`.
SecurityProtectionEnabled	Boolean	No	false	Indique s'il faut activer Anti-DDoS Pro/Premium. Valeurs possibles : false (valeur par défaut) true
PublicIpAddressPoolId	String	No	pippool-2vc0kxcedhquybdsz****	Le pool d'adresses IP auquel appartient l'EIP à interroger.

Paramètres de réponse

Parameter	Type	Example	Description
PageSize	Integer	10	Le nombre d'entrées par page.
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	L'ID de la requête.
PageNumber	Integer	10	Le numéro de page.
TotalCount	Integer	1	Le nombre d'entrées renvoyées.
EipAddresses	Array of EipAddress		Les détails concernant les EIP.
EipAddress
ReservationActiveTime	String	2021-05-23T16:00:00Z	L'heure à laquelle le renouvellement a pris effet. L'heure est affichée au format `YYYY-MM-DDThh:mm:ssZ`.
Status	String	Available	Le statut de l'EIP. Valeurs possibles : Associating Unassociating InUse Available Releasing
ReservationOrderType	String	RENEWCHANGE	Le type de commande de renouvellement. Valeurs possibles : RENEWCHANGE TEMP_UPGRADE UPGRADE
AllocationTime	String	2021-04-23T01:37:38Z	L'heure de création de l'EIP. L'heure est affichée au format `YYYY-MM-DDThh:mm:ssZ`.
Netmode	String	public	Le type de réseau. Seule la valeur public peut être renvoyée.
ChargeType	String	PostPaid	La méthode de facturation de l'EIP. Valeurs possibles : PostPaid : paiement à l'utilisation PrePaid : abonnement
Description	String	abc	La description de l'EIP.
SegmentInstanceId	String	eipsg-t4nr90yik5oy38xd****	Les ID des EIP contiguës. Cette valeur est renvoyée uniquement lorsque vous interrogez des EIP contiguës.
ReservationInternetChargeType	String	PayByBandwidth	La méthode de comptage utilisée après la prise d'effet du renouvellement. Valeurs possibles : PayByBandwidth : paiement à la bande passante. PayByTraffic : paiement au transfert de données.
BandwidthPackageId	String	cbwp-bp1ego3i4j07ccdvf****	L'ID du plan de bande passante EIP.
IpAddress	String	47.75.XX.XX	L'adresse IP de l'EIP.
Bandwidth	String	5	La bande passante maximale des EIP contiguës. Unité : Mbit/s.
ReservationBandwidth	String	12	La bande passante maximale après la prise d'effet du renouvellement. Unité : Mbit/s.
EipBandwidth	String	101	La bande passante maximale de l'EIP lorsqu'elle n'est pas associée à un plan de bande passante EIP. Unité : Mbit/s.
Name	String	EIP-01	Le nom de l'EIP.
InstanceRegionId	String	cn-hangzhou	L'ID de région de l'instance associée.
DeletionProtection	Boolean	true	Indique si la protection contre la suppression est activée. Valeurs possibles : true false
InstanceId	String	i-bp15zckdt37cdvf****	L'ID de l'instance associée.
SecondLimited	Boolean	false	Indique si la limitation de niveau 2 est configurée. Valeurs possibles : true false
InstanceType	String	EcsInstance	Le type de l'instance associée. Valeurs possibles : EcsInstance : une instance ECS dans un VPC SlbInstance : une instance SLB dans un VPC Nat : une passerelle NAT HaVip : une HAVIP NetworkInterface : une carte réseau secondaire (ENI) IpAddress : une adresse IP
HDMonitorStatus	String	false	Indique si la surveillance fine est activée pour l'EIP. Valeurs possibles : false true
RegionId	String	cn-hangzhou	L'ID de région de l'EIP.
BandwidthPackageBandwidth	String	50	La bande passante maximale du plan de bande passante EIP auquel l'EIP est associée. Unité : Mbit/s.
ServiceManaged	Integer	0	Indique si la ressource est créée par le compte de service. 0 : non 1 : oui
ExpiredTime	String	2021-05-23T02:00:00Z	L'heure d'expiration de l'EIP. L'heure est affichée au format `YYYY-MM-DDThh:mm:ssZ`.
ResourceGroupId	String	rg-acfmxazcdxs****	L'ID du groupe de ressources.
AllocationId	String	eip-2zeerraiwb7ujcdvf****	L'ID de l'EIP.
InternetChargeType	String	PayByBandwidth	La méthode de comptage de l'EIP. Valeurs possibles : PayByBandwidth : paiement à la bande passante. PayByTraffic : paiement au transfert de données.
BusinessStatus	String	Normal	Le statut de service de l'EIP. Valeurs possibles : Normal FinancialLocked
BandwidthPackageType	String	CommonBandwidthPackage	Le type de bande passante. Seule la valeur CommonBandwidthPackage (Bande passante partagée Internet) peut être renvoyée.
HasReservationData	String	false	Indique si les données de renouvellement sont incluses. false true Ce paramètre renvoie true uniquement lorsque le paramètre IncludeReservationData est défini sur true et que certaines commandes n'ont pas encore pris effet.
ISP	String	BGP	Le type de ligne. Valeurs possibles : BGP : BGP (Multi-ISP). Toutes les régions prennent en charge les EIP BGP (Multi-ISP). BGP_PRO : lignes BGP (Multi-ISP) Pro. Seules les régions suivantes prennent en charge les lignes BGP (Multi-ISP) Pro : Chine (Hong Kong), Singapour, Japon (Tokyo), Malaisie (Kuala Lumpur), Philippines (Manille), Indonésie (Jakarta) et Thaïlande (Bangkok). Pour plus d'informations sur BGP (Multi-ISP) et BGP (Multi-ISP) Pro, consultez Types de lignes EIP. Si vous êtes autorisé à utiliser la bande passante mono-opérateur, l'une des valeurs suivantes est renvoyée : ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2 Si vos services sont déployés dans China East 1 Finance, BGP_FinanceCloud est renvoyé.
OperationLocks	Array of LockReason		Les détails concernant l'EIP verrouillée.
LockReason
LockReason	String	financial	La raison du verrouillage de l'EIP. Valeurs possibles : financial security
Tags	Array of Tag		La liste des tags de l'EIP.
Tag
Key	String	KeyTest	La clé de tag de l'EIP.
Value	String	ValueTest	La valeur de tag de l'EIP.
SecurityProtectionTypes	Array of String	AntiDDoS_Enhanced	L'édition d'Anti-DDoS. Si une valeur vide est renvoyée, cela indique qu'Anti-DDoS Origin Basic est utilisé. Si AntiDDoS_Enhanced est renvoyé, cela indique qu'Anti-DDoS Pro/Premium est utilisé.
PublicIpAddressPoolId	String	pippool-2vc0kxcedhquybdsz****	L'ID du pool d'adresses IP auquel appartient l'EIP.
VpcId	String	vpc-bp15zckdt37pq72zv****	L'ID du VPC pour lequel les passerelles IPv4 sont activées et qui est déployé dans la même région que l'EIP. Lorsque vous associez une EIP à une adresse IP, le système peut permettre à l'adresse IP d'accéder à Internet en fonction des configurations de routage du VPC. Remarque Ce paramètre est renvoyé si InstanceType est défini sur IpAddress. Dans ce cas, l'EIP est associée à une adresse IP.
Zone	String	ap-southeast-1-lzdvn-cb	La zone de l'EIP. Ce paramètre est renvoyé uniquement lorsque le type de service est CloudBox.
BizType	String	CloudBox	Le type de service. CloudBox Seuls les utilisateurs de CloudBox peuvent sélectionner ce type. Default (par défaut)

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=DescribeEipAddresses
&RegionId=cn-hangzhou
&IncludeReservationData=false
&Status=Available
&EipAddress=47.75.XX.XX
&AllocationId=eip-2zeerraiwb7ujxscd****
&SegmentInstanceId=eipsg-t4nr90yik5oy38xdy****
&ResourceGroupId=rg-acfmxazb4pcdvf****
&PageNumber=10
&PageSize=10
&ISP=BGP
&Filter.1.Key=CreationStartTime
&Filter.2.Key=CreationEndTime
&Filter.1.Value=2023-01-01T01:00Z
&Filter.2.Value=2023-01-06T02:00Z
&LockReason=financial
&AssociatedInstanceType=EcsInstance
&AssociatedInstanceId=i-2zebb08phyccdvf****
&ChargeType=PostPaid
&DryRun=false
&EipName=EIP-01
&Tag=[null]
&SecurityProtectionEnabled=false
&PublicIpAddressPoolId=pippool-2vc0kxcedhquybdsz****
&Common request parameters

Exemples de réponses réussies

XML format

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

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

JSON format

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

{
  "PageSize" : 10,
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber" : 10,
  "TotalCount" : 1,
  "EipAddresses" : [ {
    "ReservationActiveTime" : "2021-05-23T16:00:00Z",
    "Status" : "Available",
    "ReservationOrderType" : "RENEWCHANGE",
    "AllocationTime" : "2021-04-23T01:37:38Z",
    "Netmode" : "public",
    "ChargeType" : "PostPaid",
    "Description" : "abc",
    "SegmentInstanceId" : "eipsg-t4nr90yik5oy38xd****",
    "ReservationInternetChargeType" : "PayByBandwidth",
    "BandwidthPackageId" : "cbwp-bp1ego3i4j07ccdvf****",
    "IpAddress" : "47.75.XX.XX",
    "Bandwidth" : "5",
    "ReservationBandwidth" : "12",
    "EipBandwidth" : "101",
    "Name" : "EIP-01",
    "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" : "financial"
    } ],
    "Tags" : [ {
      "Key" : "KeyTest",
      "Value" : "ValueTest"
    } ],
    "SecurityProtectionTypes" : [ "AntiDDoS_Enhanced" ],
    "PublicIpAddressPoolId" : "pippool-2vc0kxcedhquybdsz****",
    "VpcId" : "vpc-bp15zckdt37pq72zv****",
    "Zone" : "ap-southeast-1-lzdvn-cb",
    "BizType" : "CloudBox"
  } ]
}

Codes d'erreur

HttpCode	Error code	Error message	Description
400	InvalidIAssociatedInstanceType.ValueNotSupported	The specified value of AssociatedInstanceType is not supported.	Le message d'erreur renvoyé car AssociatedInstanceType est défini sur une valeur non valide. Vérifiez si la valeur est valide.
400	InvalidChargeType.ValueNotSupported	The specified ChargeType is not supported.	La méthode de facturation n'est pas prise en charge. Sélectionnez une méthode de facturation prise en charge.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	L'ID de groupe de ressources spécifié n'existe pas.
400	InvalidTagKey	The tag keys are not valid.	L'index de tag n'est pas valide.
400	InvalidTagValue	The tag values are not valid.	La valeur de tag n'est pas valide.
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.	La fonctionnalité de groupe de ressources est désactivée.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.	La région spécifiée n'existe pas. Vérifiez si l'ID de région spécifié est valide.
404	InvalidLockReason.NotFound	The specified LockReason is not found	La raison pour laquelle l'instance est verrouillée est inconnue.

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