DescribeIpAddressPoolCidrBlocks--公网IP-火山引擎

文档中心

立即注册

导航

DescribeIpAddressPoolCidrBlocks

最近更新时间：2024.09.06 10:16:24首次发布时间：2024.09.06 10:16:24

调用 DescribeIpAddressPoolCidrBlocks 接口，查询指定IP地址池网段信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeIpAddressPoolCidrBlocks	要执行的操作，取值：DescribeIpAddressPoolCidrBlocks。
Version	String	是	2020-04-01	API的版本信息，当前版本为2020-04-01。
IpAddressPoolId	String	是	ippool-fda83op****	IP地址池的 ID。您可以调用 DescribeIpAddressPools 接口，查询IP地址池的ID。
CidrBlock	String	否	101.0.XX.XX/24	IP地址网段。
PageNumber	Integer	否	1	列表的页数，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数。最大值为100，默认值为20。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a****	分页查询凭证，用于标记分页的位置。不填则从头开始查询。传入之前调用本API返回的`NextToken`，则从该次API调用标记分页的位置往后开始查询。
MaxResults	Integer	否	50	查询的数量，最大值为100，默认为 10。

返回数据

参数名称	类型	示例值	描述
RequestId	String	20210624153033015207C4****	请求ID。
TotalCount	Integer	1	符合条件的IP地址池网段总数。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	当前分页的行数。
NextToken	String	caeba0bbb2be03f84eb48b699f0a****	本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。
IpAddressPooCidrBlocks	Array of Struct	-	IP地址池的网段信息。具体请参见下表“IpAddressPooCidrBlock结构”。

IpAddressPooCidrBlock

参数名称	类型	示例值	描述
CidrBlock	String	101.x.x.x/24	IP地址池网段。
Status	String	Available	IP地址池网段的状态。取值如下： Creating：创建中。 Available：可用。 Deleting：删除中。 Pending：配置中。
UsedIpCount	Integer	1	IP地址池中已分配为EIP的IP地址网段数量。
TotalIpCount	Integer	256	IP地址池中包含的IP地址段总数。
CreationTime	String	2021-07-15T21:46:15+08:00	IP地址池的创建时间。

请求示例

GET /?Action=DescribeIpAddressPoolCidrBlocks&Version=2020-04-01&CidrBlock=101.0.XX.XX/24&IpAddressPoolId=ippool-fda83op\*\*\*\* HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210624153033015207C4****",
        "Action": "DescribeIpAddressPoolCidrBlocks",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result":{
         "RequestId": "20210624153033015207C4****",
         "IpAddressPooCidrBlock": [
        {
             "CidrBlock": "101.0.XX.XX/24",
             "Status":"Available",
             "UsedIpCount":1,
             "TotalIpCount":256,
             "CreationTime":"2021-07-15T21:46:15+08:00"
         
         }
            ]
          "TotalCount": 1,
          "PageNumber":1
          "PageSize":10,
          "NextToken":"caeba0bbb2be03f84eb48b699f0a****"
          
     }
    
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
	InvalidCidr.Malformed	The specified cidr block is malformed.	指定的网段格式不合法。
	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
404	InvalidIPPool.NotFound	The specified IP address pool does not exist.	指定的IP地址池不存在。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。