GetIpamPoolAllocation - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the details of a CIDR block allocation in a specified 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:GetIpamPoolAllocation

get

*IpamPool

acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region of the IPAM pool to which the CIDR block allocation belongs. Note If the IPAM pool has a region attribute, this parameter specifies the region of the IPAM pool. If the IPAM pool does not have a region attribute, this parameter specifies the managed region of IPAM.	cn-hangzhou
IpamPoolAllocationId	string	Yes	The ID of the IPAM pool allocation.	ipam-pool-alloc-112za33e4****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	3748DEFF-68BE-5EED-9937-7C1D0C21BAB4
IpamPoolAllocationId	string	The ID of the IPAM pool 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 sub-pool. Custom: The resource is a custom reserved CIDR block.	VPC
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.	1616080591216318
RegionId	string	The region of the IPAM pool to which the CIDR block allocation belongs. Note If the IPAM pool has a region attribute, this parameter specifies the region of the IPAM pool. If the IPAM pool does not have a region attribute, this parameter specifies the managed region of IPAM.	cn-hangzhou
IpamPoolId	string	The ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
Status	string	The status of the allocation. Valid values: Created Deleted	Created
CreationTime	string	The time when the allocation was created.	2024-10-15T10:24:19+08:00
IpamPoolAllocationDescription	string	The description of the IPAM pool allocation. The description must be 1 to 256 characters long. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. If you do not specify this parameter, the description is empty.	ipam pool allocation description
IpamPoolAllocationName	string	The name of the IPAM pool allocation. The name must be 1 to 128 characters long and cannot start with `http://` or `https://`.	ipam pool allocation name

Examples

Success response

JSON format

{
  "RequestId": "3748DEFF-68BE-5EED-9937-7C1D0C21BAB4",
  "IpamPoolAllocationId": "ipam-pool-alloc-112za33e4****",
  "Cidr": "192.168.1.0/24",
  "SourceCidr": "192.168.0.0/16",
  "ResourceId": "vpc-bp16qjewdsunr41m1****",
  "ResourceType": "VPC",
  "ResourceRegionId": "cn-hangzhou",
  "ResourceOwnerId": 1616080591216318,
  "RegionId": "cn-hangzhou",
  "IpamPoolId": "ipam-pool-6rcq3tobayc20t****",
  "Status": "Created",
  "CreationTime": "2024-10-15T10:24:19+08:00",
  "IpamPoolAllocationDescription": "ipam pool allocation description",
  "IpamPoolAllocationName": "ipam pool allocation name"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.IpamPoolAllocation	The specified resource of IPAM pool allocation is not found.	The specified allocation does not exist.
400	OperationDenied.IpamRegionNotSupportGetPoolAllocation	The operation is not allowed because IPAM region does not support getting the allocation.	The operation is not allowed because IPAM region does not support getting the allocation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.