查询IPAM地址池预置的CIDR地址段。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:ListIpamPoolCidrs | list | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | IPAM 托管地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
IpamPoolId | string | 是 | IPAM 地址池的实例 ID。 | ipam-pool-6rcq3tobayc20t**** |
Cidr | string | 否 | 要查询的预置 CIDR 地址段。 说明
目前,只支持 IPv4 类型的地址段。
| 192.168.1.0/24 |
NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
MaxResults | integer | 否 | 分批次查询时返回的最多条目数。取值范围:1~100,默认值为 10。 | 10 |
返回参数
示例
正常返回示例
JSON
格式
{
"IpamPoolCidrs": [
{
"IpamPoolId": "ipam-pool-6rcq3tobayc20t****",
"Cidr": "192.168.1.0/24",
"Status": "Created"
}
],
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"TotalCount": 1000,
"MaxResults": 10,
"Count": 10,
"RequestId": "9E7CCB95-62E0-534D-9B9A-71F27E8B71B1"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | OperationDenied.PoolRegionNotSupportListPoolCidr | The operation is not allowed because pool region does not support listing cidrs. | 操作被拒绝,原因是无法在该地域执行查询地址池CIDR操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-12 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |