查询已发现资源中VPC或VSwitch下已使用IP信息。
接口说明
支持的查询组合包括：仅 VpcId、仅 VSwitchId、VpcId+VSwitchId、VpcId+Cidr、VSwitchId+Cidr、 VpcId+VSwitchId+Cidr。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
资源发现实例的托管地域 ID。 |
cn-hangzhou |
| IpamResourceDiscoveryId |
string |
是 |
资源发现实例 ID。 |
ipam-res-disco-jt5f2af2u6nk2z321**** |
| VpcId |
string |
否 |
已发现资源中的 VPC 实例 ID。 说明
VpcId 和 VSwitchId 至少传入其中一个。 |
vpc-bp1fjfnrg3av6zb9e**** |
| VSwitchId |
string |
否 |
已发现资源中的 VSwitch 实例 ID。 说明
VpcId 和 VSwitchId 至少传入其中一个。 |
vsw-bp1bmwg5u07e1l3q0is4w |
| Cidr |
string |
否 |
通过指定地址段，查询 VPC 或 VSwitch 内该地址段中已使用的 IP 信息，支持/32 精确匹配单个 IP 地址。 说明
目前，只支持 IPv4 类型的地址段。 |
192.168.1.0/24 |
| IpVersion |
string |
否 |
IP 地址协议版本。取值：
枚举值：
|
IPv4 |
| NextToken |
string |
否 |
是否拥有下一次查询的令牌（Token）。取值：
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults |
integer |
否 |
分批次查询时返回的最多条目数。取值范围：1~200，默认值为 100。 |
100 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
ListTokenResult |
||
| IpamDiscoveredIpAddresses |
array<object> |
已使用 IP 地址信息列表。 |
|
|
object |
|||
| VpcId |
string |
VPC 实例 ID。 |
vpc-bp1fjfnrg3av6zb9e**** |
| VSwitchId |
string |
VSwitch 实例 ID。 |
vsw-bp1bmwg5u07e1l3q0is4w |
| IpVersion |
string |
IP 地址协议版本。取值：
|
IPv4 |
| IpAddress |
string |
已使用 IP 地址。 |
192.168.10.40/32 |
| ResourceId |
string |
资源 ID。 |
eni-bp1001jpjhzmgc5m**** |
| ResourceRegionId |
string |
资源归属的地域 ID。 |
cn-shenzhen |
| ResourceServiceType |
string |
资源归属云服务类型。 |
ENI |
| NextToken |
string |
是否拥有下一次查询的令牌（Token）。取值：
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| TotalCount |
integer |
本次请求条件下的数据总量。 |
1000 |
| MaxResults |
integer |
分批次查询时返回的最多条目数。取值范围：1~200，默认值为 100。 |
100 |
| Count |
integer |
分批次查询时返回的具体条目数。 |
10 |
| RequestId |
string |
请求 ID。 |
9F8315CB-560E-5F1E-B069-6E44B440CAF8 |
示例
正常返回示例
JSON格式
{
"IpamDiscoveredIpAddresses": [
{
"VpcId": "vpc-bp1fjfnrg3av6zb9e****",
"VSwitchId": "vsw-bp1bmwg5u07e1l3q0is4w",
"IpVersion": "IPv4",
"IpAddress": "192.168.10.40/32",
"ResourceId": "eni-bp1001jpjhzmgc5m****",
"ResourceRegionId": "cn-shenzhen",
"ResourceServiceType": "ENI"
}
],
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"TotalCount": 1000,
"MaxResults": 100,
"Count": 10,
"RequestId": "9F8315CB-560E-5F1E-B069-6E44B440CAF8"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | ResourceNotFound.IpamResourceDiscovery | The dependent instance of IPAM resource discovery is not found. | 未找到IPAM资源发现实例。 |
| 400 | MissingParam.IpamResourceDiscoveryId | The IpamResourceDiscoveryId must be input. | 查询发现的资源时，请输入参数IpamResourceDiscoveryId。 |
| 400 | Forbidden.IpResourceAccess | The IPAM resource discovery instance in the parameters is not allowed to access the IP address of resource %s. | 入参中的资源发现实例不允许访问资源%s的IP address信息。 |
| 400 | IllegalParamFormat.%s | The param of %s is illegal. | 参数%s不合法。 |
| 400 | ResourceNotFound.IpamDiscoveredResource | The queried %s is not found among IPAM discovered resources. | 所查询的%s在IPAM已发现资源中不存在。 |
| 400 | Mismatch.VpcIdAndVSwitchId | VpcId and VSwitchId do not match. | VpcId和VSwitchId不匹配。 |
| 400 | MissingParam.VpcIdAndVSwitchId | VpcId and VSwitchId cannot both be empty please provide at least one. | 入参VpcId和VSwitchId不能均为空值，至少填入其中一个。 |
| 400 | Mismatch.IpamResourceDiscoveryAndResource | The IPAM resource discovery %s and the queried %s do not match. | 资源发现实例%s和所查询资源%s不匹配。 |
| 400 | ResourceNotFound.IpamDiscoveredResource.Vpc | The queried VPC %s is not found among IPAM discovered resources. | 所查询的VPC %s 不存在于IPAM已发现资源列表中。 |
| 400 | ResourceNotFound.IpamDiscoveredResource.VSwitch | The queried VSwitch %s is not found among IPAM discovered resources. | 所查询的VSwitch %s 不存在于IPAM已发现资源列表中。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。