Elastic IP Address
Elastic IP Address
Document
- Documentation
Elastic IP AddressAPI referenceIP address poolDescribeIpAddressPoolCidrBlocks - Query IP Address Pool CidrBlock Information
Copy page
Download PDFIP address pool
DescribeIpAddressPoolCidrBlocks - Query IP Address Pool CidrBlock Information
Copy pageDownload PDFDescribeIpAddressPoolCidrBlocks - Query IP Address Pool CidrBlock Information
Call the DescribeIpAddressPoolCidrBlocks interface to query the CidrBlock information of the specified IP Address Pool.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.
Action String Example: DescribeIpAddressPoolCidrBlocks
The action to perform. Value: DescribeIpAddressPoolCidrBlocks.
Version String Example value: 2020-04-01
API version information. The current version is 2020-04-01.
IpAddressPoolId String example: ippool-fda83op****
The ID of the IP address pool.
CidrBlock String optional Example: 101.0.XX.XX/24
IP address CIDR block.
NextToken String optional example value: caeba0bbb2be03f84eb48b699f0a****
The pagination token that is used to mark the position in pagination queries.
- If left blank, start querying from the beginning.
- Pass in the NextToken returned by the previous call of this API. The query starts from the pagination position marked by that API call onward.
MaxResults Integer optional example value: 50
Number of queries, maximum 100, default is 10.
Response parameter
The following only details response parameters specific to this API. For more information, see Response structure.
RequestId String optional Example: 20210624153033015207C4****
Request ID.
NextToken String optional example value: caeba0bbb2be03f84eb48b699f0a****
The query token returned by this API call, marking the pagination position for the next query. An empty return indicates no next page.
IpAddressPoolCidrBlocks Object[] optional example value: -
CidrBlock information of the IP address pool.
CidrBlock String optional Example: 101.x.x.x/24
IP address pool CIDR block.
Status String optional example value: Available
The state of the IP Address Pool CidrBlock. Values:
- Creating
- Available
- Deleting
- Pending: Configuration in progress.
UsedIpCount Integer optional example value: 1
The number of IP addresses allocated as EIP within the IP Address Pool.
TotalIpCount Integer optional Example: 256
The total number of IP addresses in the IP address pool.
CreationTime String optional example: 2021-07-15T21:46:15+08:00
The creation time of the IP address pool.
Request examples
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
X-Date: 20250804T033538Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/vpc/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response examples
{
"ResponseMetadata": {
"RequestId": "20210624153033015207C4****",
"Action": "DescribeIpAddressPoolCidrBlocks",
"Version": "2020-04-01",
"Service": "vpc",
"Region": "cn-beijing"
},
"Result":{
"RequestId": "20210624153033015207C4****",
"IpAddressPooCidrBlocks": [
{
"CidrBlock": "101.0.XX.XX/24",
"Status":"Available",
"UsedIpCount":1,
"TotalIpCount":256,
"CreationTime":"2021-07-15T21:46:15+08:00"
}
]
"NextToken":"caeba0bbb2be03f84eb48b699f0a****"
}
}
Error codes
Last updated: 2025.12.22 11:04:18
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
