DescribeMultiIpAddressGroups
処理概要
マルチIPアドレスグループの情報を取得します。1回のリクエストで、複数のマルチIPアドレスグループ情報を取得できます。
マルチIPアドレスグループの情報を指定するためには、マルチIPアドレスグループユニークIDが必要です。指定しない場合は、取得可能なすべてのマルチIPアドレスグループの情報を取得します。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
MultiIpAddressGroupId.n | string |
マルチIPアドレスグループユニークID |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
DescribeMultiIpAddressGroupsResponse | - |
DescribeMultiIpAddressGroupsのレスポンス Ancestor: なし Children: requestId | multiIpAddressGroupsSet |
requestId | string |
リクエスト識別子 Ancestor: DescribeMultiIpAddressGroupsResponse Children: なし |
multiIpAddressGroupsSet | - |
マルチIPアドレスグループ情報 Ancestor: DescribeMultiIpAddressGroupsResponse Children: item |
item | - |
マルチIPアドレスグループ情報 Ancestor: multiIpAddressGroupsSet Children: availabilityZone | createTime | description | instancesSet | multiIpAddressGroupId | multiIpAddressGroupName | multiIpAddressNetwork | status |
availabilityZone | string |
ゾーン情報 Ancestor: item Children: なし |
createTime | string |
作成日時 Ancestor: item Children: なし |
description | string |
メモ情報(CDATA付) Ancestor: item Children: なし |
instancesSet | - |
マルチIPアドレスグループに紐づくサーバー情報 Ancestor: item Children: item |
item | - |
サーバー情報 Ancestor: instancesSet Children: instanceId | instanceUniqueId |
instanceId | string |
サーバー名 Ancestor: item Children: なし |
instanceUniqueId | string |
サーバーユニークID Ancestor: item Children: なし |
multiIpAddressGroupId | string |
マルチIPアドレスグループユニークID Ancestor: item Children: なし |
multiIpAddressGroupName | string |
マルチIPアドレスグループ名 Ancestor: item Children: なし |
multiIpAddressNetwork | - |
マルチIPアドレスグループネットワーク情報 Ancestor: item Children: defaultGateway | ipAddressesSet | subnetMask |
defaultGateway | string |
マルチIPアドレスグループネットワークのデフォルトゲートウェイ Ancestor: multiIpAddressNetwork Children: なし |
ipAddressesSet | - |
確保しているマルチIPアドレス情報 Ancestor: multiIpAddressNetwork Children: item |
item | - |
マルチIPアドレス情報 Ancestor: ipAddressesSet Children: ipAddress |
ipAddress | string |
マルチIPアドレス Ancestor: item Children: なし |
subnetMask | string |
マルチIPアドレスグループネットワークのサブネットマスク Ancestor: multiIpAddressNetwork Children: なし |
status | string |
マルチIPアドレスグループのステータス 値:
Children: なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?
Action=DescribeMultiIpAddressGroups
&CommonParams
応答サンプル
<DescribeMultiIpAddressGroupsResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>cec1c6a8-9642-413c-a741-2f56e9138b64</requestId>
<multiIpAddressGroupsSet>
<item>
<availabilityZone>east-11</availabilityZone>
<createTime>2019-09-30T20:58:23+09:00</createTime>
<description><![CDATA[memo]]></description>
<instancesSet>
<item>
<instanceId>server01</instanceId>
<instanceUniqueId>i-0123abcd</instanceUniqueId>
</item>
</instancesSet>
<multiIpAddressGroupId>mipag-0123abcd</multiIpAddressGroupId>
<multiIpAddressGroupName>group01</multiIpAddressGroupName>
<multiIpAddressNetwork>
<defaultGateway>192.0.2.1</defaultGateway>
<ipAddressesSet>
<item>
<ipAddress>192.0.2.2</ipAddress>
</item>
</ipAddressesSet>
<subnetMask>255.255.0.0</subnetMask>
</multiIpAddressNetwork>
<status>available</status>
</item>
</multiIpAddressGroupsSet>
</DescribeMultiIpAddressGroupsResponse>