本文へジャンプします。

ニフクラ APIリファレンス

DescribeVpnGateways

処理概要

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

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

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

  • nifty-vpn-gateway-name
  • nifty-vpn-gateway-description

指定するパラメーター

パラメーター 説明 必須 サンプル値
VpnGatewayId.n VPNゲートウェイユニークID
Type : String
   
NiftyVpnGatewayName.n VPNゲートウェイ名
Type : String
   
Filter.n.Name 絞り込み条件の項目名
Type : String
値:attachment.state(接続状態) | attachment.vpc-id | availability-zone(ゾーン) | state(VPNゲートウェイステータス) | type(VPN接続方式) | vpn-gateway-id(VPNゲートウェイユニークID) | nifty-vpn-gateway-name(VPNゲートウェイ名) | nifty-vpn-gateway-type(VPNゲートウェイタイプ) | nifty-vpn-gateway-description(VPNゲートウェイメモ) | nifty-vpn-gateway-accountingType(VPNゲートウェイ利用料金タイプ) | ip-address(VPNゲートウェイのIPアドレス) | latest-version-information(VPNゲートウェイルータのversionの更新情報) | version(ルータVPNゲートウェイのversion情報)
   
Filter.n.Value.m 絞り込み条件の値
Type : String
   

応答フィールド

フィールド 説明 サンプル値
DescribeVpnGatewaysResponse DescribeVpnGatewayレスポンス
Type : DescribeVpnGatewaysResponseType
Ancestor : なし
Children : requestId, vpnGatewaySet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeVpnGatewaysResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
vpnGatewaySet VPNゲートウェイ情報セット
Type : VpnGatewaySetType
Ancestor : DescribeVpnGatewaysResponse
Children : item
 
item VPNゲートウェイ情報
Type : VpnGatewayType
Ancestor : vpnGatewaySet
Children : vpnGatewayId,niftyVpnGatewayName,state,type,availabilityZone,attachments,tagSet,niftyVpnGatewayType,niftyRedundancy,niftyVpnGatewayDescription,accountingType,networkInterfaceSet,groupSet,createdTime,versionInformation,backupInformation,routeTableId,routeTableAssociationId
 
vpnGatewayId VPNゲートウェイユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
niftyVpnGatewayName VPNゲートウェイ名
Type : xsd:string
Ancestor : item
Children : なし
 
state VPNゲートウェイステータス
Type : xsd:string
値: pending (処理中) | available (起動中) | stopped (停止済み) | warning (異常あり)
Ancestor : item
Children : なし
available
type ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
availabilityZone ゾーン名
Type : xsd:string
Ancestor : item
Children : なし
 
attachments ※空を返却
Type : AttachmentType
Ancestor : item
Children : item
 
item ※返却値なし
Type : AttachmentItemType
Ancestor : attachments
Children : vpcId,state
 
vpcId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
state ※返却値なし
Type : xsd:string
値: attaching(接続中) | attached(接続済) | detaching(解除中) | detached(未接続)
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 : なし
 
niftyVpnGatewayType VPNゲートウェイのタイプ
Type : xsd:string
値: small | medium | large
Ancestor : item
Children : なし
 
niftyRedundancy 冗長化オプション
Type : xsd:boolean
Ancestor : item
Children : なし
 
niftyVpnGatewayDescription メモ
Type : xsd:string
Ancestor : item
Children : なし
 
accountingType 利用料金タイプ
Type : xsd:string
値: 1 (月額課金) | 2 (従量課金)
Ancestor : item
Children : なし
 
nextMonthAccountingType 次月からの利用料金タイプ
Type : xsd:string
値: 1 (月額課金) | 2 (従量課金)
Ancestor : item
Children : なし
 
versionInformation VPNゲートウェイのversion情報
Type :versionInformationType
Ancestor :item
Children :isLatest, version
 
isLatest VPNゲートウェイのversion最新状態
Type :xsd:boolean
Ancestor :versionInformation
Children :なし
 
version VPNゲートウェイのversion情報
Type :xsd:String
Ancestor :versionInformation
Children :なし
 
networkInterfaceSet ネットワークインターフェイス情報セット
Type : NetworkInterfaceSetType
Ancestor : item
Children : item
 
item ネットワークインターフェイス情報
Type : NetworkInterfaceSetItemType
Ancestor : networkInterfaceSet
Children : networkId,networkName,deviceIndex,ipAddress,cidrBlock,descriprion
 
networkId ネットワークユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
networkName ネットワーク名
Type : xsd:string
Ancestor : item
Children : なし
 
deviceIndex デバイス番号
Type : xsd:integer
Ancestor : item
Children : なし
 
ipAddress IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
cidrBlock ネットワークのCIDR
Type : xsd:string
Ancestor : item
Children : なし
 
descriprion ネットワークのメモ
Type : xsd:string
Ancestor : item
Children : なし
 
backupInformation バックアップ情報セット
Type :BackupInformationType
Ancestor :item
Children :isBackup, expirationDate
 
isBackup バックアップが存在するか
Type :xsd:boolean
Ancestor :backupInformation
Children :なし
 
expirationDate バックアップの保持期限
Type :xsd:dateTime
Ancestor :backupInformation
Children :なし
 
groupSet ファイアウォール情報セット
Type : GroupSetType
Ancestor : item
Children : item
 
item ファイアウォール情報
Type : GroupItemType
Ancestor : groupSet
Children : groupId
 
groupId ファイアウォールグループ名
Type : xsd:string
Ancestor : item
Children : なし
 
routeTableId ルートテーブルID
Type :xsd:string
Ancestor :item
Children :なし
 
routeTableAssociationId ルートテーブル適用ID
Type :xsd:string
Ancestor :item
Children :なし
 
createdTime 作成日時
Type : xsd:dateTime
Ancestor : item
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeVpnGateways&VpnGatewayId.1=vgw-8db04f81&Filter.1.Name=state&Filter.1.Value.1=available&CommonParams

応答サンプル

<DescribeVpnGatewaysResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <vpnGatewaySet>
  <item>
   <vpnGatewayId>vgw-8db04f81</vpnGatewayId>
   <niftyVpnGatewayName>create01</niftyVpnGatewayName>
   <state>available</state>
   <availabilityZone>east-11</availabilityZone>
   <attachments/>
   <tagSet/>
   <niftyVpnGatewayType>medium</niftyVpnGatewayType>
   <niftyRedundancy>false</niftyRedundancy>
   <niftyVpnGatewayDescription>1</niftyVpnGatewayDescription>
   <accountingType>1</accountingType>
   <nextMonthAccountingType>2</nextMonthAccountingType>
   <versionInformation>
    <isLatest>true</isLatest>
    <version>vyos 1.1.5</version>
   </versionInformation>
   <networkInterfaceSet>
    <item>
     <networkId>net-COMMON_GLOBAL</networkId>
     <networkName>net-COMMON_GLOBAL</networkName>
     <deviceIndex>0</deviceIndex>
     <ipAddress>111.171.134.162</ipAddress>
    </item>
    <item>
     <networkId>net-0nzh8np7</networkId>
     <networkName>network6</networkName>
     <deviceIndex>0</deviceIndex>
     <ipAddress>192.168.100.1</ipAddress>
     <cidrBlock>192.168.100.0/24</cidrBlock>
     <description>1</description>
    </item>
   </networkInterfaceSet>
   <backupInformation>
    <isBackup>true</isBackup>
    <expirationDate>fw01</expirationDate>
   </backupInformation>
   <groupSet>
    <item>
     <groupId>2015/01/01</groupId>
    </item>
   </groupSet>
   <routeTableId>rt-01234567</routeTableId>
   <routeTableAssociationId>rtbassoc-01234567</routeTableAssociationId>
   <createdTime>2015-01-15T14:02:21+09:00</createdTime>
  </item>
 </vpnGatewaySet>
</DescribeVpnGatewaysResponse>

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

APIメニュー

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

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