查询资源发现下的资源信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
资源发现实例的托管地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 |
cn-hangzhou |
| IpamResourceDiscoveryId |
string |
是 |
资源发现实例 ID。 |
ipam-res-disco-jt5f2af2u6nk2z321**** |
| ResourceRegionId |
string |
是 |
资源发现的操作地域。 |
cn-hangzhou |
| ResourceType |
string |
否 |
资源类型。取值：
|
VPC |
| NextToken |
string |
否 |
是否拥有下一次查询的令牌（Token）。取值：
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults |
integer |
否 |
分批次查询时返回的最多条目数。取值范围：1~100，默认值为 10。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回的信息列表。 |
||
| IpamDiscoveredResources |
array<object> |
资源列表信息。 |
|
|
array<object> |
资源列表信息。 |
||
| AliUid |
integer |
阿里云账号（主账号）ID。 |
132193271328**** |
| ResourceType |
string |
资源类型。取值：
|
VPC |
| ResourceId |
string |
资源 ID。 |
vpc-uf611fp465c7dyb4z**** |
| ResourceName |
string |
资源名称。 |
|
| ResourceOwnerId |
integer |
资源归属的阿里云账号（主账号）ID。 |
132193271328**** |
| ResourceRegionId |
string |
资源归属的地域 ID。 |
cn-hangzhou |
| Cidr |
string |
资源的地址段。 |
192.168.1.0/32 |
| IpUsage |
string |
IP 的利用率，小数形式。 |
0 |
| IpCountDetail |
object |
资源 IP 地址数量详情。 |
|
| FreeIpCount |
string |
可分配 IP 地址数量。 |
|
| TotalIpCount |
string |
总 IP 地址数量。 |
|
| UsedIpCount |
string |
已分配 IP 地址数量。 |
|
| IpamResourceDiscoveryId |
string |
资源发现实例 ID。 |
ipam-res-disco-jt5f2af2u6nk2z321**** |
| VpcId |
string |
资源所属的 VPC 实例 ID。 |
vpc-uf611fp465c7dyb4z**** |
| DiscoveryTime |
string |
资源被发现的时间。 说明
如果资源被创建后未被修改过，资源被发现的时间保持不变。 |
2024-01-01 00:00:00 |
| SourceCidr |
string |
源 CIDR 地址段。 |
192.168.1.0/24 |
| NextToken |
string |
是否拥有下一次查询的令牌（Token）。取值：
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| TotalCount |
integer |
本次请求条件下的数据总量。 |
1000 |
| MaxResults |
integer |
分批次查询时返回的最多条目数。取值范围：1~100，默认值为 10。 |
10 |
| Count |
integer |
分批次查询时返回的具体条目数。 |
10 |
| RequestId |
string |
请求 ID。 |
3748DEFF-68BE-5EED-9937-7C1D0C21BAB4 |
示例
正常返回示例
JSON格式
{
"IpamDiscoveredResources": [
{
"AliUid": 0,
"ResourceType": "VPC",
"ResourceId": "vpc-uf611fp465c7dyb4z****",
"ResourceName": "",
"ResourceOwnerId": 0,
"ResourceRegionId": "cn-hangzhou",
"Cidr": "192.168.1.0/32",
"IpUsage": "0",
"IpCountDetail": {
"FreeIpCount": "",
"TotalIpCount": "",
"UsedIpCount": ""
},
"IpamResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****",
"VpcId": "vpc-uf611fp465c7dyb4z****",
"DiscoveryTime": "2024-01-01 00:00:00",
"SourceCidr": "192.168.1.0/24"
}
],
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"TotalCount": 1000,
"MaxResults": 10,
"Count": 10,
"RequestId": "3748DEFF-68BE-5EED-9937-7C1D0C21BAB4"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | IllegalParam.ResourceRegion | The input parameter ResourceRegionId is invalid. | 输入的参数ResourceRegionId未在操作地域中。 |
| 400 | ResourceNotFound.IpamResourceDiscovery | The dependent instance of IPAM resource discovery is not found. | 未找到IPAM资源发现实例。 |
| 400 | MissingParam.IpamResourceDiscoveryId | The IpamResourceDiscoveryId must be input. | 查询发现的资源时，请输入参数IpamResourceDiscoveryId。 |
| 400 | MissingParam.ResourceRegionId | The ResourceRegionId must be input. | 查询发现的资源时，请输入参数ResourceRegionId。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。