查询IPAM地址池的CIDR分配信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:ListIpamPoolAllocations | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | IPAM 地址池 CIDR 分配所属 IPAM Pool 的所在地域。 说明
当 IPAM 地址池 CIDR 分配所属 IPAM Pool 具备地域属性时，该属性为 IPAM Pool 的所在地域。当 IPAM 地址池 CIDR 分配所属 IPAM Pool 不具备地域属性时，该属性为 IPAM 托管地域。
| cn-hangzhou |
| IpamPoolId | string | 是 | IPAM 地址池的实例 ID。 | ipam-pool-6rcq3tobayc20t**** |
| IpamPoolAllocationIds | array | 否 | IPAM 地址池 CIDR 分配的实例 ID 列表。 | |
| IpamPoolAllocationId | string | 否 | IPAM 地址池 CIDR 分配的实例 ID。最多支持输入 20 个实例 ID。 | ipam-pool-alloc-112za33e4**** |
| Cidr | string | 否 | 通过指定分配的地址段查询分配信息。 说明
目前，只支持 IPv4 类型的地址段。
| 192.168.1.0/24 |
| IpamPoolAllocationName | string | 否 | IPAM 地址池 CIDR 分配的名称。 长度为 1～128 个字符，不能以 | test name |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults | integer | 否 | 分批次查询时返回的最多条目数。取值范围：1~100，默认值为 10。 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"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"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | OperationDenied.IpamRegionNotSupportListPoolAllocation | The operation is not allowed because IPAM region does not support listing allocations. | 无法在IPAM地域执行查询地址池分配的操作。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-28 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-09-12 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |