You need to enable JavaScript to run this app.
文档中心
公网IP

公网IP

复制全文
下载 pdf
IP地址池
DescribeIpAddressPoolCidrBlocks - 查询IP地址池的网段信息
复制全文
下载 pdf
DescribeIpAddressPoolCidrBlocks - 查询IP地址池的网段信息
调用 DescribeIpAddressPoolCidrBlocks 接口 ,查询指定IP地址池网段信息。​
请求说明​
  • 请求方式:GET​
  • 请求地址:/?Action=DescribeIpAddressPoolCidrBlocks&Version=2020-04-01​
调试​
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。​
​
NextToken string 可选 示例值:caeba0bbb2be03f84eb48b699f0a****​
分页查询凭证,用于标记分页的位置。​
  • 不填则从头开始查询。​
  • 传入之前调用本API返回的NextToken,则从该次API调用标记分页的位置往后开始查询。​
​
MaxResults integer 可选 示例值:50​
查询的数量,最大值为100,默认为 10。​
​
CidrBlock string 可选 示例值:101.0.XX.XX/24​
IP地址网段。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
IpAddressPoolCidrBlocks object[] 示例值:-​
IP地址池的网段信息。​
CidrBlock string 示例值:101.0.XX.XX/24​
IP地址池网段。​
​
TotalIpCount integer 示例值:256​
IP地址池IP地址总数。​
​
UsedIpCount integer 示例值:1​
IP地址池网段已用IP地址数。​
​
Status string 示例值:Available​
IP地址池网段的状态。取值如下:​
  • Creating:创建中。​
  • Available:可用。​
  • Deleting:删除中。​
  • Pending:配置中。​
​
CreationTime string 示例值:2021-07-15T21:46:15+08:00​
IP地址池网段的创建时间。​
​
​
RequestId string 示例值:20210624153033015207C4****​
请求ID。​
​
NextToken string 示例值:caeba0bbb2be03f84eb48b699f0a****​
本次API调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。​
​
​
​
请求示例​
​
GET /?Action=DescribeIpAddressPoolCidrBlocks&Version=2020-04-01&CidrBlock=101.0.XX.XX/24&IpAddressPoolId=ippool-fda83op\*\*\*\* HTTP/1.1​
Host: vpc.cn-beijing.volcengineapi.com​
Service: vpc​
Region: cn-beijing​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20210624153033015207C4****",​
"Action": "DescribeIpAddressPoolCidrBlocks",​
"Version": "2020-04-01",​
"Service": "vpc",​
"Region": "cn-beijing"​
},​
"Result":{​
"RequestId": "20210624153033015207C4****",​
"IpAddressPoolCidrBlocks": [​
{​
"CidrBlock": "101.0.XX.XX/24",​
"Status":"Available",​
"UsedIpCount":1,​
"TotalIpCount":256,​
"CreationTime":"2021-07-15T21:46:15+08:00"​
}​
],​
"NextToken":"caeba0bbb2be03f84eb48b699f0a****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter​
The request is missing a required parameter.​
该请求缺少必要参数。​
400​
InvalidParameter​
A parameter specified in the request is not valid, is unsupported or cannot be used.​
该请求传入了非法或不支持的参数。​
400​
InvalidCidr.Malformed​
The specified cidr block is malformed.​
指定的网段格式不合法。​
404​
InvalidIPPool.NotFound​
The specified IP address pool does not exist.​
指定的IP地址池不存在。​
409​
InvalidOperation.Conflict​
The specified resource operation conflicts.​
指定的资源操作冲突。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。​
​
​
最近更新时间:2026.10.14 16:39:42
这个页面对您有帮助吗?
有用
有用
无用
无用