ListIpamPools - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries information about IPAM pools.

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:ListIpamPools

list

*IpamPool

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the managed region. You can call the DescribeRegions operation to query region IDs.	cn-hangzhou
IpamScopeId	string	No	The ID of the IPAM scope.	ipam-scope-glfmcyldpm8lsy****
IpamPoolIds	array	No	A list of IPAM pool IDs. You can specify up to 100 IDs.
	string	No	The ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
IpamPoolName	string	No	The name of the IPAM pool. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	test
SourceIpamPoolId	string	No	The ID of the source IPAM pool.	ipam-pool-lfnwi4jok1ss0g****
PoolRegionId	string	No	The region where the IPAM pool is available.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group to which the IPAM pool belongs.	rg-aek2sermdd6****
Tags	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key. You can specify up to 20 tag keys. The key cannot be an empty string. The key can be up to 64 characters in length. It must start with a letter and can contain digits, periods (.), underscores (_), and hyphens (-). The key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The value can be an empty string. The value can be up to 128 characters in length and cannot contain `http://` or `https://`.	FinanceJoshua
NextToken	string	No	The token that is used to retrieve the next page of results. Valid values: You do not need to specify this parameter for the first call. Set this parameter to the value of NextToken that was returned in the previous call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
IsShared	boolean	No	Specifies whether the address pool is a shared pool.	true
IpVersion	string	No	The IP version. Valid values: IPv4 IPv6	IPv4
Ipv6Isp	string	No	The line type of the IPv6 CIDR block. This parameter is valid only for public IPv6 address pools. Valid values: BGP (default): Alibaba Cloud BGP IPv6. ChinaMobile ChinaUnicom ChinaTelecom Note If your account is whitelisted for single-line bandwidth, you can set this parameter to ChinaTelecom, ChinaUnicom, or ChinaMobile.	BGP

Response elements

Element	Type	Description	Example
	object	The response.
IpamPools	array<object>	A list of IPAM pools.
	object	A list of IPAM pools.
IpamId	string	The ID of the IPAM instance.	ipam-b5mtlx3q7xcnyr****
IpamScopeId	string	The ID of the IPAM scope.	ipam-scope-glfmcyldpm8lsy****
IpamScopeType	string	The type of the IPAM scope. Valid values: public: the public network. private: the private network.	private
IpamPoolId	string	The ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
IpamPoolName	string	The name of the IPAM pool.	test
IpamPoolDescription	string	The description of the IPAM pool.	test description
CreateTime	string	The time when the IPAM pool was created.	2023-04-19T16:49:01Z
RegionId	string	The ID of the region.	cn-hangzhou
PoolDepth	integer	The depth of the IPAM pool. Valid values: 0 to 10.	2
HasSubPool	boolean	Indicates whether the IPAM pool has sub-pools. Valid values: true false	true
SourceIpamPoolId	string	The ID of the source IPAM pool.	ipam-pool-lfnwi4jok1ss0g****
Status	string	The status of the IPAM pool. Valid values: Creating Created Modifying Deleting Deleted	Created
IpVersion	string	The IP version.	IPv4
AllocationDefaultCidrMask	integer	The default subnet mask for the IPAM pool.	28
AllocationMaxCidrMask	integer	The maximum subnet mask for the IPAM pool.	32
AllocationMinCidrMask	integer	The minimum subnet mask for the IPAM pool.	8
ResourceGroupId	string	The ID of the resource group to which the IPAM pool belongs.	rg-acfmxazb4ph6aiy****
Tags	array<object>	The tags.
	object	The tags.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua
PoolRegionId	string	The ID of the region where the IPAM pool is available.	cn-hangzhou
IpamRegionId	string	The managed region of the IPAM instance to which the IPAM pool belongs.	cn-hangzhou
OwnerId	integer	The Alibaba Cloud account ID of the owner of the IPAM pool.	1210123456******
AutoImport	boolean	Indicates whether auto import is enabled for the address pool.	true
IsShared	boolean	Indicates whether the address pool is a shared pool.	true
Ipv6Isp	string	The line type of the IPv6 CIDR block.	BGP
Cidrs	array	The CIDR blocks that are provisioned for the address pool.
	string	The CIDR block that is provisioned for the address pool.	10.214.0.0/16
NextToken	string	A pagination token. It can be 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 is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries returned.	1000
MaxResults	integer	The maximum number of entries returned on each page. Valid values: 1 to 100. Default value: 10.	10
Count	integer	The number of entries returned on the current page.	10
RequestId	string	The request ID.	B54867DE-83DC-56B4-A57E-69A03119D0B1

Examples

Success response

JSON format

{
  "IpamPools": [
    {
      "IpamId": "ipam-b5mtlx3q7xcnyr****",
      "IpamScopeId": "ipam-scope-glfmcyldpm8lsy****",
      "IpamScopeType": "private",
      "IpamPoolId": "ipam-pool-6rcq3tobayc20t****",
      "IpamPoolName": "test",
      "IpamPoolDescription": "test description",
      "CreateTime": "2023-04-19T16:49:01Z",
      "RegionId": "cn-hangzhou",
      "PoolDepth": 2,
      "HasSubPool": true,
      "SourceIpamPoolId": "ipam-pool-lfnwi4jok1ss0g****",
      "Status": "Created",
      "IpVersion": "IPv4",
      "AllocationDefaultCidrMask": 28,
      "AllocationMaxCidrMask": 32,
      "AllocationMinCidrMask": 8,
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "PoolRegionId": "cn-hangzhou",
      "IpamRegionId": "cn-hangzhou",
      "OwnerId": 0,
      "AutoImport": true,
      "IsShared": true,
      "Ipv6Isp": "BGP",
      "Cidrs": [
        "10.214.0.0/16"
      ]
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1000,
  "MaxResults": 10,
  "Count": 10,
  "RequestId": "B54867DE-83DC-56B4-A57E-69A03119D0B1"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.