查询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 |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults | integer | 否 | 分批次查询时返回的最多条目数。取值范围：1~100，默认值为 10。 | 10 |
| VpcId | string | 否 | 资源所属的 VPC 实例 ID。 | vpc-bp1fjfnrg3av6zb9e**** |
返回参数
示例
正常返回示例
JSON格式
{
"IpamResourceCidrs": [
{
"AliUid": 0,
"ResourceType": "VPC",
"ResourceId": "vpc-bp16qjewdsunr41m1****",
"ResourceOwnerId": 0,
"ResourceRegionId": "cn-hangzhou",
"Cidr": "192.168.1.0/32",
"SourceCidr": "192.168.1.0/24",
"Status": "Created",
"ManagementStatus": "Managed",
"ComplianceStatus": "Compliant",
"OverlapStatus": "Nonoverlapping",
"IpUsage": "0",
"IpamId": "ipam-uq5dcfc2eqhpf4****",
"IpamScopeId": "ipam-scope-glfmcyldpm8lsy****",
"IpamPoolId": "ipam-pool-6rcq3tobayc20t***",
"IpamAllocationId": "ipam-pool-alloc-112za33e4****",
"VpcId": "vpc-bp1fjfnrg3av6zb9e****",
"OverlapDetail": [
{
"OverlapResourceId": "vpc-aq3fjgnig5av6jb8d****",
"OverlapResourceRegion": "cn-hangzhou",
"OverlapResourceCidr": "192.168.1.0/24"
}
]
}
],
"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地址池的资源失败。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-01-23 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-09-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |