调用ListPublicIpAddressPools接口查询用户可使用的IP地址池信息

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListPublicIpAddressPools	系统规定参数。取值：ListPublicIpAddressPools。
PublicIpAddressPoolIds.N	String	否	pippool-6wetvn6fumkgycssx****	IP地址池的实例ID列表。您最多可输入100个IP地址池的实例ID。
Status	String	否	Created	IP地址池实例状态。取值： Created：可用。 Deleting：删除中。 Modifying：修改中。
MaxResults	Integer	否	10	本次读取的最大数据记录数量。取值范围：10~100。默认值：10。
NextToken	String	否	FFmyTO70tTpLG6I3FmYAXGKPd****	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。
Isp	String	否	BGP	线路类型。取值： BGP（默认值）：BGP（多线）线路。 BGP_PRO：BGP（多线）_精品线路。关于BGP（多线）线路和BGP（多线）_精品线路的更多信息，请参见EIP线路类型。如果您是单线带宽的白名单用户，您还可以选择以下类型： ChinaTelecom：中国电信 ChinaUnicom：中国联通 ChinaMobile：中国移动 ChinaTelecom_L2：中国电信L2 ChinaUnicom_L2：中国联通L2 ChinaMobile_L2：中国移动L2 如果您是杭州金融云用户，该字段必填，取值：BGP_FinanceCloud。
Name	String	否	AddressPoolName	地址池实例的名称。描述可以为空，或输入1~128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`http://`或`https://`开头。
DryRun	Boolean	否	false	是否只预检此次请求。取值： true：发送检查请求，不会查询可使用的IP地址池信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。
ResourceGroupId	String	否	rg-acfmxazb4pcdvf****	IP地址池所属的资源组ID。
Tags.N.Key	String	否	FinanceDept	标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。一个标签键最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。
Tags.N.Value	String	否	FinanceJoshua	标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。一个标签值最多支持128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。
RegionId	String	是	cn-chengdu	要查询的IP地址池所在的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

返回数据


名称	类型	示例值	描述
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	请求ID。
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。如果NextToken有返回值，该取值表示下一次查询开始的令牌。
TotalCount	Integer	1	本次请求条件下的数据总量。
PublicIpAddressPoolList	Array of PublicIpAddressPool		IP地址池的实例列表。
PublicIpAddressPoolId	String	pippool-6wetvn6fumkgycssx****	IP地址池的实例ID。
RegionId	String	cn-chengdu	要查询的IP地址池所在的地域ID。
CreationTime	String	2022-05-10T01:37:38Z	创建时间，格式为`YYYY-MM-DDThh:mm:ssZ`。
Isp	String	BGP	线路类型。 BGP：BGP（多线）线路。 BGP_PRO：BGP（多线）_精品线路。关于BGP（多线）线路和BGP（多线）_精品线路的更多信息，请参见EIP线路类型。如果您是单线带宽的白名单用户，返回类型还可能为： ChinaTelecom：中国电信 ChinaUnicom：中国联通 ChinaMobile：中国移动 ChinaTelecom_L2：中国电信L2 ChinaUnicom_L2：中国联通L2 ChinaMobile_L2：中国移动L2 如果您是杭州金融云用户，返回BGP_FinanceCloud。
Name	String	AddressPoolName	IP地址池实例的名称。
Status	String	Created	IP地址池实例状态。 Created：可用。 Deleting：删除中。 Modifying：修改中。
Description	String	AddressPoolDescription	IP地址池实例的描述。
TotalIpNum	Integer	100	公网IP地址池可用IP地址总数。
UsedIpNum	Integer	20	公网IP地址池已用IP地址数。
IpAddressRemaining	Boolean	true	是否还有空闲的IP地址。 true：是。 false：否。
UserType	Boolean	admin	用户的类型。取值： admin：管理员，表示可以删除、修改、查询IP地址池以及为IP地址池分配弹性公网IP（Elastic IP Address，简称EIP）等操作。 user：普通用户，表示只能为IP地址池分配EIP以及查询IP地址池，但是无法修改以及删除IP地址池。
OwnerId	Long	121012345612****	IP地址池所属的阿里云账号（主账号）。
ShareType	String	Shared	IP地址池的共享类型。 Shared：表示该IP地址池为共享的IP地址池。空：表示该IP地址池不是共享的IP地址池。
ResourceGroupId	String	rg-acfmxazb4pcdvf****	IP地址池所属的资源组ID。
Tags	Array of Tag		标签列表。
Key	String	FinanceDept	标签键。
Value	String	FinanceDept	标签值。

示例

请求示例

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
&公共请求参数

正常返回示例

XML格式

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>
    </PublicIpAddressPoolList>
</ListPublicIpAddressPoolsResponse>

JSON格式

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"
    } ]
  } ]
}

错误码

访问错误中心查看更多错误码。