查询IPAM作用范围内的资源。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
vpc:ListIpamResourceCidrs |
list |
*IpamScope
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
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**** |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回的信息列表。 |
||
IpamResourceCidrs |
array<object> |
资源信息列表。 |
|
object |
资源信息列表。 |
||
Status |
string |
IPAM 地址池中的资源状态。取值:
|
Created |
ManagementStatus |
string |
资源的管理状态。
|
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 |
SourceCidr |
string |
源 CIDR 地址段。 |
192.168.1.0/24 |
ComplianceStatus |
string |
资源的合规状态。
|
Compliant |
IpamPoolId |
string |
IPAM 地址池的实例 ID。 |
ipam-pool-6rcq3tobayc20t*** |
IpamId |
string |
IPAM 的实例 ID。 |
ipam-uq5dcfc2eqhpf4**** |
IpCountDetail |
object |
||
FreeIpCount |
string |
||
TotalIpCount |
string |
||
UsedIpCount |
string |
||
IpamAllocationId |
string |
IPAM 地址池 CIDR 分配的实例 ID。 |
ipam-pool-alloc-112za33e4**** |
ResourceType |
string |
资源类型。取值:
|
VPC |
ResourceOwnerId |
integer |
资源归属的阿里云账号(主账号)ID。 |
132193271328**** |
IpamScopeId |
string |
IPAM 作用范围的实例 ID。 |
ipam-scope-glfmcyldpm8lsy**** |
IpUsage |
string |
IP 的利用率,小数形式。 |
0 |
Cidr |
string |
资源的地址段。 |
192.168.1.0/32 |
VpcId |
string |
资源所属的 VPC 实例 ID。 |
vpc-bp1fjfnrg3av6zb9e**** |
ResourceId |
string |
资源 ID。 |
vpc-bp16qjewdsunr41m1**** |
AliUid |
integer |
阿里云账号(主账号)ID。 |
132193271328**** |
NextToken |
string |
是否拥有下一次查询的令牌(Token)。取值:
|
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": "",
"TotalIpCount": "",
"UsedIpCount": ""
},
"IpamAllocationId": "ipam-pool-alloc-112za33e4****",
"ResourceType": "VPC",
"ResourceOwnerId": 0,
"IpamScopeId": "ipam-scope-glfmcyldpm8lsy****",
"IpUsage": "0",
"Cidr": "192.168.1.0/32",
"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地址池的资源失败。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。