ListPublicIpAddressPools - - Alibaba Cloud ドキュメントセンター

利用可能なIPアドレスプールを照会します。

制限事項

必要な権限を持つユーザーのみがElastic IP address (EIP) のIPアドレスプール機能を使用できます。 To apply for the required permissions, submit a ticket.

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター


項目	データ型	必須／任意	例:	説明
操作	String	必須	ListPublicIpAddressPools	実行する操作です。値をListPublicIpAddressPoolsに設定します。
PublicIpAddressPoolIds.N	String	任意	pippool-6wetvn6fumkgycssx ****	IPアドレスプールのID。 IDは最大100個まで入力可能です。
Status	String	任意	作成済み	IPアドレスプールのステータス。有効な値：作成済み: 利用可能 Deleting: 削除中 Modifying: 変更中
MaxResults	Integer	いいえ	10	返されるエントリの最大数。有効な値: 10〜100。デフォルト値: 10
NextToken	String	任意	FFmyTO70tTpLG6I3FmYAXGKPd ****	次のクエリに使用されるトークン。有効な値：これが最初のクエリである場合、または次のクエリを送信しない場合は、このパラメーターを無視します。次のクエリを送信する場合は、パラメーターを前回の呼び出しから返されたNextTokenの値に設定します。
Isp	String	任意	BGP	ラインタイプ。有効な値： BGP (デフォルト): BGP (マルチISP) 行。全地域でBGP（Multi-ISP）EIPをサポートしています。 BGP_PRO: BGP (マルチISP) プロライン。 BGP (Multi-ISP) Pro EIPは、中国 (香港) およびシンガポールのリージョンでのみサポートされています。 BGP (マルチISP) およびBGP (マルチISP) Proの詳細については、「EIPラインタイプ」をご参照ください。単一ISP帯域幅の使用が許可されている場合は、次のいずれかの値を選択することもできます。 ChinaTelecom: 中国テレコム ChinaUnicom: 中国のユニコム ChinaMobile: チャイナモバイル ChinaTelecom_L2: チャイナテレコムL2 ChinaUnicom_L2: 中国ユニコムL2 ChinaMobile_L2: チャイナモバイルL2 サービスがChina East 1 Financeにデプロイされている場合、このパラメーターは必須であり、値をBGP_FinanceCloudに設定する必要があります。
名前	String	任意	AddressPoolName	IPアドレスプールの名前。このパラメーターはオプションです。名前を入力する場合、名前は1 ~ 128文字で、数字、ピリオド (.) 、アンダースコア (_) 、ハイフン (-) を使用できます。名前は文字で始める必要がありますが、`http://` または`https://` で始めることはできません。
DryRun	Boolean	いいえ	false	操作を実行せずにリクエストをチェックするかどうかを指定します。有効な値： true: 操作を実行せずにリクエストをチェックします。システムは、必要なパラメーター、要求構文、および制限をチェックします。要求がチェックに失敗した場合、エラーメッセージが返されます。リクエストがチェックに合格すると、`DryRunOperation`エラーコードが返されます。 false (デフォルト): リクエストを送信します。リクエストがチェックに合格すると、2xx HTTPステータスコードが返され、操作が実行されます。
RegionId	String	必須	cn-chengdu	IPアドレスプールのリージョンID。 DescribeRegionsを呼び出して、使用可能なリージョンを照会できます。

レスポンスパラメーター


項目	データ型	例:	説明
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	リクエストの ID です。
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd ****	次のクエリに使用されるトークン。有効な値： NextTokenが空の場合、次のクエリを送信しないことを示します。 NextTokenの値が返された場合、その値は次のクエリで使用されるトークンです。
MaxResults	Integer	10	返されるエントリの最大数。
TotalCount	Integer	1	返されたエントリの総数。
PublicIpAddressPoolList	PublicIpAddressPoolの配列		IPアドレスプールのリスト。
PublicIpAddressPoolId	String	pippool-6wetvn6fumkgycssx ****	IPアドレスプールのID。
RegionId	String	cn-chengdu	IPアドレスプールのリージョンID。
CreationTime	String	2022-05-10T01:37:38Z	IPアドレスプールが作成された時刻。時刻は`YYYY-MM-DDThh:mm:ssZ`形式で表示されます。
Isp	String	BGP	ラインタイプ。 BGP: BGP (マルチISP) 回線すべてのリージョンがBGP (マルチISP) EIPをサポートしています。 BGP_PRO: BGP (マルチISP) プロライン。 BGP (Multi-ISP) Pro EIPは、中国 (香港) およびシンガポールのリージョンでのみサポートされています。 BGP (マルチISP) およびBGP (マルチISP) Proの詳細については、「EIPラインタイプ」をご参照ください。単一ISP帯域幅の使用が許可されている場合、次のいずれかの値が返されます。 ChinaTelecom: 中国テレコム ChinaUnicom: 中国のユニコム ChinaMobile: チャイナモバイル ChinaTelecom_L2: チャイナテレコムL2 ChinaUnicom_L2: 中国ユニコムL2 ChinaMobile_L2: チャイナモバイルL2 サービスがChina East 1 Financeにデプロイされている場合、BGP_FinanceCloudが返されます。
名前	String	AddressPoolName	IPアドレスプールの名前。
Status	String	作成済み	IPアドレスプールのステータス。有効な値：作成済み: 利用可能 Deleting: 削除中 Modifying: 変更中
説明	String	AddressPoolDescription	IPアドレスプールの説明。
TotalIpNum	Integer	100	パブリックIPアドレスプール内のIPアドレスの総数。
UsedIpNum	Integer	20	パブリックIPアドレスプール内の占有IPアドレスの数。
IpAddressRemaining	ブール	真実	IPアドレスプールにアイドルIPアドレスがあるかどうかを示します。 true: はい false: いいえ
UserType	ブール	admin	ユーザータイプ。 admin: 管理者 user: 承認されたユーザー

例

リクエストの例

http(s):// [エンドポイント]/?Action=ListPublicIpAddressPools
&PublicIpAddressPoolIds=["pippool-6wetvn6fumkgycssx ****"]
&ステータス=作成済み
&MaxResults=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd ****
&Isp=BGP
&Name=AddressPoolName
&DryRun=false
&RegionId=cn-chengdu
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

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

<ListPublicIpAddressPoolsResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd ****</NextToken>
    <MaxResults>10</MaxResults>
    <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> 作成 </Status>
        <Description>AddressPoolDescription</Description>
        <TotalIpNum>100</TotalIpNum>
        <UsedIpNum>20</UsedIpNum>
        <IpAddressRemaining>true</IpAddressRemaining>
        <UserType>false</UserType>
    </PublicIpAddressPoolList>
</ListPublicIpAddressPoolsResponse>

JSON 形式

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

{
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF" 、
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd ****" 、
  "MaxResults" : 10、
  "TotalCount" : 1、
  "PublicIpAddressPoolList" : [ {
    "PublicIpAddressPoolId" : "pippool-6wetvn6fumkgycssx ****" 、
    "RegionId" : "cn-chengdu" 、
    "CreationTime" : "2022-05-10T01:37:38Z" 、
    "Isp" : "BGP" 、
    "Name" : "AddressPoolName" 、
    "ステータス" : "作成" 、
    "Description" : "AddressPoolDescription" 、
    "TotalIpNum" : 100、
    "UsedIpNum" : 20、
    "IpAddressRemaining" : true、
    "UserType" : false
  } ]
}

エラーコード

エラーコードのリストについては、エラーセンターをご覧ください。