VPC または VSwitch で検出されたリソースによって使用されている IP アドレスを一覧表示します。
操作説明
サポートされているクエリの組み合わせは、VpcId のみ、VSwitchId のみ、VpcId と VSwitchId、VpcId と CIDR、VSwitchId と CIDR、および VpcId、VSwitchId、CIDR です。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リソース検出インスタンスがホストされているリージョンの ID。 |
cn-hangzhou |
| IpamResourceDiscoveryId |
string |
必須 |
リソース検出インスタンスの ID。 |
ipam-res-disco-jt5f2af2u6nk2z321**** |
| VpcId |
string |
任意 |
検出された VPC の ID。 説明
VpcId と VSwitchId のうち、少なくとも 1 つを指定する必要があります。 |
vpc-bp1fjfnrg3av6zb9e**** |
| VSwitchId |
string |
任意 |
検出された VSwitch の ID。 説明
VpcId と VSwitchId のうち、少なくとも 1 つを指定する必要があります。 |
vsw-bp1bmwg5u07e1l3q0is4w |
| Cidr |
string |
任意 |
VPC または VSwitch で使用中の IP アドレスを検索するための CIDR ブロック。 特定の IP アドレスをクエリするには、/32 プレフィックス長を使用します。 説明
IPv4 CIDR ブロックのみがサポートされています。 |
192.168.1.0/24 |
| IpVersion |
string |
任意 |
IP プロトコルバージョン。 有効な値:
列挙値:
|
IPv4 |
| NextToken |
string |
任意 |
次の結果ページを取得するために使用されるトークン。 有効な値:
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults |
integer |
任意 |
ページごとに返すエントリの最大数。 有効な値:1~200。 デフォルト値:100。 |
100 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答オブジェクト。 |
||
| 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 |
ページネーショントークン。 このトークンを後続のリクエストで使用して、次の結果ページを取得します。 有効な値:
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| TotalCount |
integer |
クエリに一致するエントリの総数。 |
1000 |
| MaxResults |
integer |
ページごとに返すエントリの最大数。 有効な値:1~200。 デフォルト値:100。 |
100 |
| Count |
integer |
現在のページで返されたエントリ数。 |
10 |
| RequestId |
string |
リクエスト ID。 |
9F8315CB-560E-5F1E-B069-6E44B440CAF8 |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | ResourceNotFound.IpamResourceDiscovery | The dependent instance of IPAM resource discovery is not found. | |
| 400 | MissingParam.IpamResourceDiscoveryId | The IpamResourceDiscoveryId must be input. | |
| 400 | Forbidden.IpResourceAccess | The IPAM resource discovery instance in the parameters is not allowed to access the IP address of resource %s. | |
| 400 | IllegalParamFormat.%s | The param of %s is illegal. | |
| 400 | ResourceNotFound.IpamDiscoveredResource | The queried %s is not found among IPAM discovered resources. | |
| 400 | Mismatch.VpcIdAndVSwitchId | VpcId and VSwitchId do not match. | |
| 400 | MissingParam.VpcIdAndVSwitchId | VpcId and VSwitchId cannot both be empty please provide at least one. | |
| 400 | Mismatch.IpamResourceDiscoveryAndResource | The IPAM resource discovery %s and the queried %s do not match. | |
| 400 | ResourceNotFound.IpamDiscoveredResource.Vpc | The queried VPC %s is not found among IPAM discovered resources. | |
| 400 | ResourceNotFound.IpamDiscoveredResource.VSwitch | The queried VSwitch %s is not found among IPAM discovered resources. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。