ListIpamPoolCidrs - 查询IPAM地址池预置的CIDR地址段

查询IPAM地址池预置的CIDR地址段。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:ListIpamPoolCidrslist
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

IPAM 托管地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
IpamPoolIdstring

IPAM 地址池的实例 ID。

ipam-pool-6rcq3tobayc20t****
Cidrstring

要查询的预置 CIDR 地址段。

说明 目前,只支持 IPv4 类型的地址段。
192.168.1.0/24
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时返回的最多条目数。取值范围:1~100,默认值为 10。

10

返回参数

名称类型描述示例值
object

ListTokenResult

IpamPoolCidrsarray<object>

IPAM 地址池预置的 CIDR 地址段列表。

IpamPoolCidrobject

IPAM 地址池预置的 CIDR 地址段列表。

IpamPoolIdstring

IPAM 地址池的实例 ID。

ipam-pool-6rcq3tobayc20t****
Cidrstring

预置的 CIDR 地址段。

192.168.1.0/24
Statusstring

IPAM 地址池预置 CIDR 的实例状态。取值:

  • Created:表示创建完成。
  • Deleted:表示已删除。
Created
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCountlong

查询的条目总数。

1000
MaxResultslong

分批次查询时返回的最多条目数。取值范围:1~100,默认值为 10。

10
Countlong

分批次查询时返回的具体条目数。

10
RequestIdstring

请求 ID。

9E7CCB95-62E0-534D-9B9A-71F27E8B71B1

示例

正常返回示例

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错误码错误信息描述
400OperationDenied.PoolRegionNotSupportListPoolCidrThe operation is not allowed because pool region does not support listing cidrs.操作被拒绝,原因是无法在该地域执行查询地址池CIDR操作。

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

变更历史

变更时间变更内容概要操作
2024-09-12OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情