AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 专有网络VPC 开发参考 API参考（IP地址管理） API目录 IPAM作用范围 ListIpamResourceCidrs - 查询IPAM作用范围内的资源

ListIpamResourceCidrs - 查询IPAM作用范围内的资源

更新时间：
产品详情
我的收藏

查询IPAM作用范围内的资源。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vpc:ListIpamResourceCidrs

list

*IpamScope

acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

IPAM 托管地域 ID。

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

cn-hangzhou
IpamScopeId

string

否

IPAM 作用范围的实例 ID。

ipam-scope-glfmcyldpm8lsy****
IpamPoolId

string

否

IPAM 地址池的实例 ID。

说明

IpamPoolId 不能是共享地址池的实例 ID。

ipam-pool-6rcq3tobayc20t****
ResourceId

string

否

资源 ID。

vpc-bp16qjewdsunr41m1****
ResourceType

string

否

资源类型。取值：

  • VPC：表示资源类型为 VPC。

  • VSwitch：表示资源类型为交换机。

VPC
NextToken

string

否

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。

  • 如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults

integer

否

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

10
VpcId

string

否

资源所属的 VPC 实例 ID。

vpc-bp1fjfnrg3av6zb9e****

返回参数

名称

类型

描述

示例值

object

返回的信息列表。

IpamResourceCidrs

array<object>

资源信息列表。

object

资源信息列表。

Status

string

IPAM 地址池中的资源状态。取值：

  • Created：表示已创建。

  • Deleted：表示已删除。

Created
ManagementStatus

string

资源的管理状态。

  • Managed（托管）：该资源具有从 IPAM 地址池中分配的 CIDR，IPAM 正在监控该资源是否可能与 CIDR 重叠以及是否符合池分配规则。

  • Unmanaged（非托管）：该资源不具有从 IPAM 池中分配的 CIDR，IPAM 正在监控该资源是否可能存在符合池分配规则的 CIDR，并监控 CIDR 是否存在重叠。

  • Ignored（已忽略）：已选择该资源免于监控。不会评估忽略的资源是否存在重叠或分配规则合规性。选择忽略资源时，从 IPAM 地址池中分配给它的任何空间都将返回到池中，并且不会通过自动导入再次导入该资源（如果在地址池中设置了自动导入分配规则）。

Managed
OverlapDetail

array<object>

与当前资源重叠的资源信息列表。

object

OverlapResourceRegion

string

与当前资源重叠的实例地域信息。

cn-hangzhou
OverlapResourceCidr

string

与当前资源重叠的 CIDR 信息。

192.168.1.0/24
OverlapResourceId

string

与当前资源重叠的实例 ID。

vpc-aq3fjgnig5av6jb8d****
ResourceRegionId

string

资源的生效地域 ID。

cn-hangzhou
OverlapStatus

string

资源的重叠状态。

  • Nonoverlapping（不重叠）：资源的 CIDR 不与相同作用范围内的其他 CIDR 重叠。

  • Overlapping（重叠）：资源的 CIDR 与相同作用范围内的另一个 CIDR 重叠。

  • Ignored（已忽略）：已选择该资源免于监控。不会评估忽略的资源是否存在重叠或分配规则合规性。

Nonoverlapping
SourceCidr

string

源 CIDR 地址段。

192.168.1.0/24
ComplianceStatus

string

资源的合规状态。

  • Compliant（合规）：托管式资源的 CIDR 符合 IPAM 地址池的分配规则。

  • Noncompliant（不合规）：托管式资源的 CIDR 不符合 IPAM 地址池的一条或多条分配规则。

  • Ignored（已忽略）：已选择该资源免于监控。不会评估忽略的资源是否存在重叠或分配规则合规性。

  • Unmanaged（非托管式）：资源不具备从 IPAM 地址池中分配的 CIDR，IPAM 不监控该资源的 CIDR 是否符合地址池的分配规则，将监控 CIDR 是否存在重叠。

Compliant
IpamPoolId

string

IPAM 地址池的实例 ID。

ipam-pool-6rcq3tobayc20t***
IpamId

string

IPAM 的实例 ID。

ipam-uq5dcfc2eqhpf4****
IpCountDetail

object

资源 IP 地址数量详情。

FreeIpCount

string

可分配 IP 地址数量。

252
TotalIpCount

string

总 IP 地址数量。

256
UsedIpCount

string

已分配 IP 地址数量。

4
IpamAllocationId

string

IPAM 地址池 CIDR 分配的实例 ID。

ipam-pool-alloc-112za33e4****
ResourceType

string

资源类型。取值：

  • VPC：表示资源类型为 VPC。

  • VSwitch：表示资源类型为交换机。

VPC
ResourceOwnerId

integer

资源归属的阿里云账号（主账号）ID。

132193271328****
IpamScopeId

string

IPAM 作用范围的实例 ID。

ipam-scope-glfmcyldpm8lsy****
IpUsage

string

IP 的利用率，小数形式。

0
Cidr

string

资源的地址段。

192.168.1.0/24
VpcId

string

资源所属的 VPC 实例 ID。

vpc-bp1fjfnrg3av6zb9e****
ResourceId

string

资源 ID。

vpc-bp16qjewdsunr41m1****
AliUid

integer

阿里云账号（主账号）ID。

132193271328****
NextToken

string

是否拥有下一次查询的令牌（Token）。取值：

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。

FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount

integer

本次请求条件下的数据总量。

1000
MaxResults

integer

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

10
Count

integer

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

10
RequestId

string

请求 ID。

49A9DE56-B68C-5FFC-BC06-509D086F287C

示例

正常返回示例

JSON格式

{
  "IpamResourceCidrs": [
    {
      "Status": "Created",
      "ManagementStatus": "Managed",
      "OverlapDetail": [
        {
          "OverlapResourceRegion": "cn-hangzhou",
          "OverlapResourceCidr": "192.168.1.0/24",
          "OverlapResourceId": "vpc-aq3fjgnig5av6jb8d****"
        }
      ],
      "ResourceRegionId": "cn-hangzhou",
      "OverlapStatus": "Nonoverlapping",
      "SourceCidr": "192.168.1.0/24",
      "ComplianceStatus": "Compliant",
      "IpamPoolId": "ipam-pool-6rcq3tobayc20t***",
      "IpamId": "ipam-uq5dcfc2eqhpf4****",
      "IpCountDetail": {
        "FreeIpCount": "252",
        "TotalIpCount": "256",
        "UsedIpCount": "4"
      },
      "IpamAllocationId": "ipam-pool-alloc-112za33e4****",
      "ResourceType": "VPC",
      "ResourceOwnerId": 0,
      "IpamScopeId": "ipam-scope-glfmcyldpm8lsy****",
      "IpUsage": "0",
      "Cidr": "192.168.1.0/24",
      "VpcId": "vpc-bp1fjfnrg3av6zb9e****",
      "ResourceId": "vpc-bp16qjewdsunr41m1****",
      "AliUid": 0
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1000,
  "MaxResults": 10,
  "Count": 10,
  "RequestId": "49A9DE56-B68C-5FFC-BC06-509D086F287C"
}

错误码

HTTP status code

错误码

错误信息

描述
400 Forbidden.QueryShareResource Authentication is failed for querying a shared IPAM pool. 查询共享IPAM地址池的资源失败。

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

变更历史

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

上一篇：ListIpamScopes - 查询IPAM作用范围的实例信息下一篇：IPAM地址池