本文へジャンプします。

ニフクラ APIリファレンス

DescribeCustomerGateways

処理概要

指定したカスタマーゲートウェイの情報を取得します。
カスタマーゲートウェイを指定するためには、カスタマーゲートウェイユニークIDまたはカスタマーゲートウェイ名が必要です。削除済みのカスタマーゲートウェイを指定した、管理外のカスタマーゲートウェイを指定したなど、無効なカスタマーゲートウェイを指定した場合は、エラーが返されます。
カスタマーゲートウェイを指定しない場合、取得できるすべてのカスタマーゲートウェイ情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。「∗」は0個以上任意文字、「?」は1個任意文字、「¥」はエスケープ変換文字(「∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索)となります。

曖昧検索が指定可能な絞り込み条件の項目名は、下記の通りです。

  • ip-address
  • nifty-customer-gateway-name
  • nifty-customer-gateway-description

指定するパラメーター

パラメーター 説明 必須 サンプル値
CustomerGatewayId.n カスタマーゲートウェイユニークID
Type : String
   
NiftyCustomerGatewayName.n カスタマーゲートウェイ名
Type : String
   
Filter.n.Name 絞り込み条件の項目名
Type : String
値 : customer-gateway-id(カスタマーゲートウェイユニークID) | nifty-customer-gateway-name(カスタマーゲートウェイ名) | ip-address(カスタマーゲートウェイのインターネット側IPアドレス) | state(カスタマーゲートウェイステータス) | nifty-customer-gateway-description(カスタマーゲートウェイメモ)
   
Filter.n.Value.m 絞り込み条件の値
Type : String
   

応答フィールド

フィールド 説明 サンプル値
DescribeCustomerGatewaysResponse DescribeCustomerGatewaysレスポンス
Type : DescribeCustomerGatewaysResponseType
Ancestor : なし
Children : requestId, customerGatewaySet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeCustomerGatewaysResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
customerGatewaySet カスタマーゲートウェイ情報セット
Type : CustomerGatewaySetType
Ancestor : DescribeCustomerGatewaysResponse
Children : item
 
item カスタマーゲートウェイ情報
Type : CustomerGatewayItemType
Ancestor : customerGatewaySet
Children : customerGatewayId,niftyCustomerGatewayName,state,type,ipAddress,niftyLanSideIpAddress,niftyLanSideCidrBlock,bgpAsn,tagSet,niftyCustomerGatewayDescription,createdTime
 
customerGatewayId カスタマーゲートウェイユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
niftyCustomerGatewayName カスタマーゲートウェイ名
Type : xsd:string
Ancestor : item
Children : なし
 
state カスタマーゲートウェイステータス
Type : xsd:string
値: pending (処理中) | available (起動中) | stopped (停止済み) | warning (異常あり)
Ancestor : item
Children : なし
 
type ※返却値なし
Type : xsd:string
値: IPsec | L2TPv3 | IPsec
Ancestor : item
Children : なし
 
ipAddress カスタマーゲートウェイのLAN側IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
niftyLanSideIpAddress カスタマーゲートウェイのLAN側IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
niftyLanSideCidrBlock カスタマゲートウェイ(対向機器)のLAN側IPアドレス帯(CIDR)
Type : xsd:string
Ancestor : item
Children : なし
 
bgpAsn ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
tagSet リソースに設定されているタグ情報セット
Type : ResourceTagSetType
Ancestor : item
Children : item
 
item リソースに設定されているタグ情報
Type : ResourceTagSetItemType
Ancestor : tagSet
Children : key,value
 
key 設定されているタグのキー
Type : xsd:string
Ancestor : item
Children : なし
 
value 設定されているタグの値
Type : xsd:string
Ancestor : item
Children : なし
 
niftyCustomerGatewayDescription メモ
Type : xsd:string
Ancestor : item
Children : なし
 
createdTime 作成日時
Type : xsd:dateTime
Ancestor : item
Children : なし
 

リクエストサンプル

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

応答サンプル

<DescribeCustomerGatewaysResponsexmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <customerGatewaySet>
  <item>
   <customerGatewayId>cgw-b4dc3961</customerGatewayId>
   <niftyCustomerGatewayName>cgw1</niftyCustomerGatewayName>
   <state>available</state>
   <type>IPsec</type>
   <ipAddress>12.1.2.3</ipAddress>
   <niftyVpnGatewayDescription/>
  </item>
 </customerGatewaySet>
</DescribeCustomerGatewaysResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上