ListPublicIpAddressPools - - Centre de documentation Alibaba Cloud

Répertorie les pools d'adresses IP disponibles.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer pour plus de commodité. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	ListPublicIpAddressPools	Opération à effectuer. Définissez la valeur sur ListPublicIpAddressPools.
PublicIpAddressPoolIds.N	String	Non	pippool-6wetvn6fumkgycssx****	ID des pools d'adresses IP. Saisissez jusqu'à 100 ID.
Status	String	Non	Created	État du pool d'adresses IP. Valeurs possibles : Created Deleting Modifying
MaxResults	Integer	Non	10	Nombre maximal d'entrées à renvoyer. Valeurs possibles : 10 à 100. Valeur par défaut : 10.
NextToken	String	Non	FFmyTO70tTpLG6I3FmYAXGKPd****	Jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Valeurs possibles : Ne spécifiez pas ce paramètre pour la première requête. Spécifiez le jeton obtenu lors de la requête précédente comme valeur de NextToken.
Isp	String	Non	BGP	Type de ligne. Valeurs possibles : BGP (par défaut) BGP_PRO Pour plus d'informations sur BGP (Multi-ISP) et BGP (Multi-ISP) Pro, consultez la rubrique Types de lignes. Si vous êtes autorisé à utiliser la bande passante mono-ISP, vous pouvez également utiliser l'une des valeurs suivantes : ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_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.
Name	String	Non	AddressPoolName	Nom du pool d'adresses IP. Ce paramètre est facultatif. Le nom doit comporter entre 1 et 128 caractères et peut contenir des chiffres, des points (.), des traits de soulignement (_) et des traits d'union (-). Le nom doit commencer par une lettre mais ne peut pas commencer par `http://` ou `https://`.
DryRun	Boolean	Non	false	Indique s'il faut effectuer uniquement un test à blanc, sans exécuter 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 code d'erreur est renvoyé. Si la requête réussit le test à blanc, le code d'erreur `DryRunOperation` est renvoyé. false (par défaut) : effectue un test à blanc et exécute la requête réelle. Si la requête réussit le test à blanc, un code d'état HTTP 2xx est renvoyé et l'opération est effectuée.
ResourceGroupId	String	Non	rg-acfmxazb4pcdvf****	ID du groupe de ressources auquel appartient le pool d'adresses IP.
Tags.N.Key	String	Non	FinanceDept	Clé du tag N à ajouter à la ressource. Spécifiez 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://`.
Tags.N.Value	String	Non	FinanceJoshua	Valeur du tag N à ajouter à la ressource. Spécifiez 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 et ne peut pas commencer par `acs:` ou `aliyun`. La valeur de tag ne peut pas contenir `http://` ou `https://`.
RegionId	String	Oui	cn-chengdu	ID de la région dans laquelle vous souhaitez répertorier les pools d'adresses IP. Appelez l'opération DescribeRegions pour interroger la liste des régions la plus récente.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	ID de la requête.
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	Jeton de pagination. Il peut être utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Valeurs possibles : Si la valeur de NextToken n'est pas renvoyée, aucune requête suivante ne doit être envoyée. Si une valeur est renvoyée pour NextToken, elle indique le jeton à utiliser pour la requête suivante.
TotalCount	Integer	1	Nombre total d'entrées renvoyées.
PublicIpAddressPoolList	Array of PublicIpAddressPool		Liste des pools d'adresses IP.
PublicIpAddressPoolId	String	pippool-6wetvn6fumkgycssx****	ID du pool d'adresses IP.
RegionId	String	cn-chengdu	ID de la région dans laquelle vous souhaitez répertorier les pools d'adresses IP.
CreationTime	String	2022-05-10T01:37:38Z	Heure de création du pool d'adresses IP. L'heure est affichée au format `YYYY-MM-DDThh:mm:ssZ`.
Isp	String	BGP	Type de ligne. Valeurs possibles : BGP BGP_PRO Pour plus d'informations sur BGP (Multi-ISP) et BGP (Multi-ISP) Pro, consultez la rubrique Types de lignes. Si vous êtes autorisé à utiliser la bande passante mono-ISP, l'une des valeurs suivantes peut être 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é.
Name	String	AddressPoolName	Nom du pool d'adresses IP.
Status	String	Created	État du pool d'adresses IP. Valeurs possibles : Created Deleting Modifying
Description	String	AddressPoolDescription	Description du pool d'adresses IP.
TotalIpNum	Integer	100	Nombre total d'adresses IP dans le pool d'adresses IP publiques.
UsedIpNum	Integer	20	Nombre d'adresses IP occupées dans le pool d'adresses IP publiques.
IpAddressRemaining	Boolean	true	Indique si le pool d'adresses IP dispose d'adresses IP inactives. Valeurs possibles : true false
UserType	Boolean	admin	Type d'utilisateur. Valeurs possibles : admin : administrateur. Un administrateur peut supprimer, modifier et interroger des pools d'adresses IP, et allouer des adresses IP élastiques (EIP) aux pools d'adresses IP. user : utilisateur standard. Un utilisateur standard peut uniquement allouer des EIP aux pools d'adresses IP et interroger les pools d'adresses IP. Un utilisateur standard ne peut pas modifier ni supprimer de pools d'adresses IP.
OwnerId	Long	121012345612****	Compte Alibaba Cloud auquel appartient le pool d'adresses IP.
ShareType	String	Shared	Indique si le pool d'adresses IP est partagé. Seule la valeur Shared peut être renvoyée. Une valeur vide indique que le pool d'adresses IP n'est pas partagé.
ResourceGroupId	String	rg-acfmxazb4pcdvf****	ID du groupe de ressources auquel appartient le pool d'adresses IP.
Tags	Array of Tag		Liste des tags.
Key	String	FinanceDept	Clé du tag N ajouté à la ressource.
Value	String	FinanceDept	Valeur du tag N ajouté à la ressource.
BizType	String	CloudBox	Type de service du pool d'adresses IP. CloudBox Seuls les utilisateurs de Cloud Box peuvent sélectionner ce type. Default (par défaut)
Zones	Array of String	ap-southeast-1-lzdvn-cb	Zone du pool d'adresses IP. Ce paramètre est renvoyé uniquement lorsque le type de service est CloudBox.

Exemples

Exemple de requêtes

http(s)://[Endpoint]/?Action=ListPublicIpAddressPools
&PublicIpAddressPoolIds=["pippool-6wetvn6fumkgycssx****"]
&Status=Created
&MaxResults=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&Isp=BGP
&Name=AddressPoolName
&DryRun=false
&ResourceGroupId=rg-acfmxazb4pcdvf****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&RegionId=cn-chengdu
&Common request parameters

Exemple de réponses réussies

XML format

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

<ListPublicIpAddressPoolsResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <TotalCount>1</TotalCount>
    <PublicIpAddressPoolList>
        <PublicIpAddressPoolId>pippool-6wetvn6fumkgycssx****</PublicIpAddressPoolId>
        <RegionId>cn-chengdu</RegionId>
        <CreationTime>2022-05-10T01:37:38Z</CreationTime>
        <Isp>BGP</Isp>
        <Name>AddressPoolName</Name>
        <Status>Created</Status>
        <Description>AddressPoolDescription</Description>
        <TotalIpNum>100</TotalIpNum>
        <UsedIpNum>20</UsedIpNum>
        <IpAddressRemaining>true</IpAddressRemaining>
        <UserType>false</UserType>
        <ShareType>Shared</ShareType>
        <ResourceGroupId>rg-acfmxazb4pcdvf****</ResourceGroupId>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceDept</Value>
        </Tags>
        <BizType>CloudBox</BizType>
        <Zones>ap-southeast-1-lzdvn-cb</Zones>
    </PublicIpAddressPoolList>
</ListPublicIpAddressPoolsResponse>

JSON format

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

{
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount" : 1,
  "PublicIpAddressPoolList" : [ {
    "PublicIpAddressPoolId" : "pippool-6wetvn6fumkgycssx****",
    "RegionId" : "cn-chengdu",
    "CreationTime" : "2022-05-10T01:37:38Z",
    "Isp" : "BGP",
    "Name" : "AddressPoolName",
    "Status" : "Created",
    "Description" : "AddressPoolDescription",
    "TotalIpNum" : 100,
    "UsedIpNum" : 20,
    "IpAddressRemaining" : true,
    "UserType" : false,
    "ShareType" : "Shared",
    "ResourceGroupId" : "rg-acfmxazb4pcdvf****",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceDept"
    } ],
    "BizType" : "CloudBox",
    "Zones" : [ "ap-southeast-1-lzdvn-cb" ]
  } ]
}

Codes d'erreur

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