ListIpamPoolAllocations - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries information about CIDR block allocations in an IPAM pool.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:ListIpamPoolAllocations

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region of the IPAM pool that contains the CIDR block allocation. Note If the IPAM pool has a specific region, this parameter specifies that region. If the IPAM pool does not have a specific region, this parameter specifies the managed region of IPAM.	cn-hangzhou
IpamPoolId	string	Yes	The instance ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
IpamPoolAllocationIds	array	No	A list of instance IDs of the IPAM pool CIDR block allocations.
	string	No	The instance ID of an IPAM pool CIDR block allocation. The list can contain up to 20 instance IDs.	ipam-pool-alloc-112za33e4****
Cidr	string	No	The allocated CIDR block that you want to query. Note Only IPv4 CIDR blocks are supported.	192.168.1.0/24
IpamPoolAllocationName	string	No	The name of the IPAM pool CIDR block allocation. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	test name
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that determines the start point of the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The list of returned information.
IpamPoolAllocations	array<object>	A list of IPAM pool CIDR block allocations.
	object	A list of IPAM pool CIDR block allocations.
IpamPoolAllocationId	string	The instance ID of the IPAM pool CIDR block allocation.	ipam-pool-alloc-112za33e4****
Cidr	string	The allocated CIDR block.	192.168.1.0/24
SourceCidr	string	The source CIDR block.	192.168.0.0/16
ResourceId	string	The ID of the resource to which the CIDR block is allocated.	vpc-bp16qjewdsunr41m1****
ResourceType	string	The type of the resource to which the CIDR block is allocated. Valid values: VPC: The resource is a VPC. IpamPool: The resource is a child IPAM pool. Custom: The resource is a custom reserved CIDR block.	Custom
ResourceRegionId	string	The ID of the region where the resource is deployed.	cn-hangzhou
ResourceOwnerId	integer	The ID of the Alibaba Cloud account to which the resource belongs.	132193271328****
RegionId	string	The region of the IPAM pool that contains the CIDR block allocation. Note If the IPAM pool has a specific region, this parameter specifies that region. If the IPAM pool does not have a specific region, this parameter specifies the managed region of IPAM.	cn-hangzhou
IpamPoolId	string	The instance ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
Status	string	The status of the instance. Valid values: Created: The instance is created. Deleted: The instance is deleted.	Created
CreationTime	string	The time when the instance was created.	2023-05-19T08:59:18Z
IpamPoolAllocationDescription	string	The description of the IPAM pool CIDR block allocation.	test description
IpamPoolAllocationName	string	The name of the IPAM pool CIDR block allocation.	test name
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that determines the start point of the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries that meet the query conditions.	1000
MaxResults	integer	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
Count	integer	The number of entries returned for the current query.	10
RequestId	string	The request ID.	3748DEFF-68BE-5EED-9937-7C1D0C21BAB4

Examples

Success response

JSON format

{
  "IpamPoolAllocations": [
    {
      "IpamPoolAllocationId": "ipam-pool-alloc-112za33e4****",
      "Cidr": "192.168.1.0/24",
      "SourceCidr": "192.168.0.0/16",
      "ResourceId": "vpc-bp16qjewdsunr41m1****",
      "ResourceType": "Custom",
      "ResourceRegionId": "cn-hangzhou",
      "ResourceOwnerId": 0,
      "RegionId": "cn-hangzhou",
      "IpamPoolId": "ipam-pool-6rcq3tobayc20t****",
      "Status": "Created",
      "CreationTime": "2023-05-19T08:59:18Z",
      "IpamPoolAllocationDescription": "test description",
      "IpamPoolAllocationName": "test name"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1000,
  "MaxResults": 10,
  "Count": 10,
  "RequestId": "3748DEFF-68BE-5EED-9937-7C1D0C21BAB4"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.IpamRegionNotSupportListPoolAllocation	The operation is not allowed because IPAM region does not support listing allocations.	The operation is not allowed because IPAM region does not support listing allocations.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.