查詢已發現資源中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已發現資源清單中。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。