ListIpamPools - 查询IPAM地址池信息_专有网络VPC(VPC)-阿里云帮助中心

查询IPAM地址池信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vpc:ListIpamPools

list

*IpamPool

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

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	IPAM 托管地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
IpamScopeId	string	否	IPAM 作用范围的实例 ID。	ipam-scope-glfmcyldpm8lsy****
IpamPoolIds	array	否	IPAM 地址池的实例 ID 列表。N 的取值范围为 1~100，即一次最多查询 100 个 IPAM 地址池。
	string	否	IPAM 地址池的实例 ID。	ipam-pool-6rcq3tobayc20t****
IpamPoolName	string	否	IPAM 地址池的名称。长度为 1～128 个字符，不能以`http://`或`https://`开头。	test
SourceIpamPoolId	string	否	源 IPAM 地址池的实例 ID。	ipam-pool-lfnwi4jok1ss0g****
PoolRegionId	string	否	IPAM 地址池生效地域。	cn-hangzhou
ResourceGroupId	string	否	IPAM 地址池所属的资源组 ID。	rg-aek2sermdd6****
Tags	array<object>	否	标签列表信息。
	object	否	标签列表信息。
Key	string	否	标签键。最多支持输入 20 个标签键。一旦传入该值，则不允许为空字符串。一个标签键最多支持 64 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	标签值。最多支持输入 20 个标签值。一旦传入该值，可以为空字符串。一个标签值最多支持 128 个字符，不能包含`http://`或者`https://`。	FinanceJoshua
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时返回的最多条目数。取值范围：1~100，默认值为 10。	10
IsShared	boolean	否	是否是共享的地址池。	true
IpVersion	string	否	IP 地址协议版本。取值： IPv4：IPv4 协议。 IPv6：IPv6 协议。	IPv4
Ipv6Isp	string	否	IPv6 地址段类型，仅对公网 IPv6 地址池生效。取值： BGP（默认值）：阿里云 BGP IPv6。 ChinaMobile：中国移动（单线）。 ChinaUnicom：中国联通（单线）。 ChinaTelecom：中国电信（单线）。说明如果是开通了单线带宽白名单的用户，该字段可以设置为 ChinaTelecom（中国电信）、ChinaUnicom（中国联通）或 ChinaMobile（中国移动）。	BGP

返回参数

名称	类型	描述	示例值
	object	返回的信息列表。
IpamPools	array<object>	IPAM 地址池列表。
	object	IPAM 地址池列表。
IpamId	string	IPAM 的实例 ID。	ipam-b5mtlx3q7xcnyr****
IpamScopeId	string	IPAM 作用范围的实例 ID。	ipam-scope-glfmcyldpm8lsy****
IpamScopeType	string	IPAM 作用范围的作用域类型。取值： public：表示为公网类型。 private：表示为私网类型。	private
IpamPoolId	string	IPAM 地址池的实例 ID。	ipam-pool-6rcq3tobayc20t****
IpamPoolName	string	IPAM 地址池的名称。	test
IpamPoolDescription	string	IPAM 地址池的描述。	test description
CreateTime	string	IPAM 地址池的创建时间。	2023-04-19T16:49:01Z
RegionId	string	查询请求对应的当前地域 ID。	cn-hangzhou
PoolDepth	integer	IPAM 地址池的深度。取值范围：0~10。	2
HasSubPool	boolean	是否有子地址池。取值： true：是。 false：否。	true
SourceIpamPoolId	string	源 IPAM 地址池的实例 ID。	ipam-pool-lfnwi4jok1ss0g****
Status	string	IPAM 地址池实例的状态。取值： Creating：表示创建中。 Created：表示创建完成。 Modifying：表示修改中。 Deleting：表示删除中。 Deleted：表示已删除。	Created
IpVersion	string	IP 地址协议版本。	IPv4
AllocationDefaultCidrMask	integer	IPAM 地址池分配的默认网络掩码。	28
AllocationMaxCidrMask	integer	IPAM 地址池分配的最大网络掩码。	32
AllocationMinCidrMask	integer	IPAM 地址池分配的最小网络掩码。	8
ResourceGroupId	string	IPAM 地址池的资源组 ID。	rg-acfmxazb4ph6aiy****
Tags	array<object>	标签列表信息。
	object	标签列表信息。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceJoshua
PoolRegionId	string	查询到的 IPAM 地址池的生效地域 ID。	cn-hangzhou
IpamRegionId	string	查询到的 IPAM 地址池所属 IPAM 实例的托管地域。	cn-hangzhou
OwnerId	integer	IPAM 地址池资源拥有者的阿里云主账号。	1210123456******
AutoImport	boolean	地址池是否开启自动导入功能。	true
IsShared	boolean	是否是共享的地址池。	true
Ipv6Isp	string	IPv6 地址段类型。	BGP
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	查询的条目总数。	1000
MaxResults	integer	分批次查询时返回的最多条目数。取值范围：1~100，默认值为 10。	10
Count	integer	分批次查询时返回的具体条目数。	10
RequestId	string	请求 ID。	B54867DE-83DC-56B4-A57E-69A03119D0B1

示例

正常返回示例

JSON格式

{
  "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"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1000,
  "MaxResults": 10,
  "Count": 10,
  "RequestId": "B54867DE-83DC-56B4-A57E-69A03119D0B1"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。