DescribeCustomerGateways
処理概要
指定したカスタマーゲートウェイの情報を取得します。
カスタマーゲートウェイを指定するためには、カスタマーゲートウェイユニークIDまたはカスタマーゲートウェイ名が必要です。
カスタマーゲートウェイを指定しない場合、取得できるすべてのカスタマーゲートウェイ情報を取得します。
絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「∗」は0個以上任意文字、「?」は1個任意文字、「¥」はエスケープ変換文字（「∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索）となります。
曖昧検索が指定可能な絞り込み条件の項目名は、下記の通りです。
- ip-address
- nifty-customer-gateway-name
- nifty-customer-gateway-description
指定するパラメーター
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| CustomerGatewayId.n | string |
カスタマーゲートウェイユニークID |
|
| NiftyCustomerGatewayName.n | string |
カスタマーゲートウェイ名 |
|
| Filter.n.Name | string |
絞り込み条件の項目名 値:
|
|
| Filter.n.Value.m | string |
絞り込み条件の値 |
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| DescribeCustomerGatewaysResponse | - |
DescribeCustomerGatewaysレスポンス |
| ␣requestId | string |
リクエスト識別子 |
| ␣customerGatewaySet | - |
カスタマーゲートウェイ情報セット |
| ␣␣item | - |
カスタマーゲートウェイ情報 |
| ␣␣␣customerGatewayId | string |
カスタマーゲートウェイユニークID |
| ␣␣␣niftyCustomerGatewayName | string |
カスタマーゲートウェイ名 |
| ␣␣␣state | string |
カスタマーゲートウェイステータス 値:
|
| ␣␣␣ipAddress | string |
カスタマーゲートウェイのLAN側IPアドレス |
| ␣␣␣niftyLanSideIpAddress | string |
カスタマーゲートウェイのLAN側IPアドレス |
| ␣␣␣niftyLanSideCidrBlock | string |
カスタマゲートウェイ(対向機器)のLAN側IPアドレス帯(CIDR) |
| ␣␣␣tagSet | - |
※空を返却 リソースに設定されているタグ情報セット |
| ␣␣␣␣item | - |
リソースに設定されているタグ情報 |
| ␣␣␣␣␣key | string |
設定されているタグのキー |
| ␣␣␣␣␣value | string |
設定されているタグの値 |
| ␣␣␣niftyCustomerGatewayDescription | string |
メモ(CDATA付) |
| ␣␣␣createdTime | timestamp |
作成日時 |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=DescribeCustomerGateways
&CustomerGatewayId.1=cgw-8db04f81
&Filter.1.Name=state
&Filter.1.Value.1=available
&CommonParams
応答サンプル
<DescribeCustomerGatewaysResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<customerGatewaySet>
<item>
<customerGatewayId>cgw-b4dc3961</customerGatewayId>
<niftyCustomerGatewayName>cgw1</niftyCustomerGatewayName>
<state>available</state>
<ipAddress>192.168.0.1</ipAddress>
<niftyLanSideIpAddress>192.168.0.1</niftyLanSideIpAddress>
<niftyLanSideCidrBlock>192.168.0.0/24</niftyLanSideCidrBlock>
<tagSet/>
<niftyCustomerGatewayDescription><![CDATA[description]]></niftyCustomerGatewayDescription>
<createdTime>2020-07-01T13:20:25+09:00</createdTime>
</item>
</customerGatewaySet>
</DescribeCustomerGatewaysResponse>
