获取IPAM地址池可用的CIDR地址段。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:GetIpamPoolNextAvailableCidr | get | *IpamPool acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | IPAM 地址池所在地域。 说明
当 IPAM 地址池具备地域属性时，该参数为 IPAM 地址池生效地域；当 IPAM 地址池不具备地域属性时，该参数为 IPAM 托管地域。
| cn-hangzhou |
| IpamPoolId | string | 是 | IPAM 地址池的实例 ID。 | ipam-pool-6rcq3tobayc20t**** |
| CidrBlock | string | 否 | 需要分配的 CIDR。 说明
CidrBlock、CidrMask 至少输入一个。
| 172.68.0.0/26 |
| CidrMask | integer | 否 | 需要分配的 CIDR 掩码长度。 说明
CidrBlock、CidrMask 至少输入一个。
| 26 |
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "29FC6758-9B7C-5CC7-8CBF-4DD846FE7D82",
"CidrBlock": "172.68.0.0/26"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MissingParam.CidrOrCidrMask | The CIDR or CIDR Mask must be input. | 从IPAM地址池分配资源或查询可用资源时，请输入Cidr或CidrMask。 |
| 400 | ResourceNotEnough.IpamPoolCidr | The specified resource of IPAM pool CIDR is not enough. | 指定的IPAM地址池CIDR资源不足。 |
| 400 | OperationDenied.IpamRegionNotSupportGetPoolAvailableCidr | The operation is not allowed because IPAM region does not support getting available CIDR of IPAM pool. | 无法在IPAM地域执行获取地址池可用CIDR的操作。 |
| 400 | IllegalParam.Cidr | The specified CIDR is illegal. | 指定的CIDR不合法。 |
| 404 | ResourceNotFound.IpamPool | The dependent IPAM pool is not found. | 依赖资源IPAM Pool不存在。 |
访问错误中心查看更多错误码。