ニフクラAPI (コンピューティング: DescribeRemoteAccessVpnGateways)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

クラウドトップ>コンピューティング> API> DescribeRemoteAccessVpnGateways

DescribeRemoteAccessVpnGateways

処理概要

リモートアクセスVPNゲートウェイの情報を取得します。

指定するパラメーター

パラメーター	型	説明	必須
RemoteAccessVpnGatewayId.n	string	リモートアクセスVPNゲートウェイユニークID

応答フィールド

フィールド (項目)	型	説明
DescribeRemoteAccessVpnGatewaysResponse	-	DescribeRemoteAccessVpnGatewaysレスポンス
␣requestId	string	リクエスト識別子
␣remoteAccessVpnGatewaySet	-	リモートアクセスVPNゲートウェイ情報セット
␣␣item	-	リモートアクセスVPNゲートウェイ情報
␣␣␣remoteAccessVpnGatewayId	string	リモートアクセスVPNゲートウェイユニークID
␣␣␣remoteAccessVpnGatewayName	string	リモートアクセスVPNゲートウェイ名
␣␣␣remoteAccessVpnGatewayType	string	リモートアクセスVPNゲートウェイタイプ
␣␣␣accountingType	string	利用料金タイプ値: 1 (月額課金) 2 (従量課金)
␣␣␣nextMonthAccountingType	string	次月の利用料金タイプ値: 1 (月額課金) 2 (従量課金)
␣␣␣description	string	リモートアクセスVPNゲートウェイメモ情報
␣␣␣availabilityZone	string	ゾーン情報
␣␣␣status	string	リモートアクセスVPNゲートウェイステータス値: wait_create (リモートアクセスVPNゲートウェイ作成待ち) creating (リモートアクセスVPNゲートウェイ作成中) available (リモートアクセスVPNゲートウェイ利用可能) wait_update (リモートアクセスVPNゲートウェイ更新待ち) updating (リモートアクセスVPNゲートウェイ更新中) wait_delete (リモートアクセスVPNゲートウェイ削除待ち) deleting (リモートアクセスVPNゲートウェイ削除中) wait_reboot (リモートアクセスVPNゲートウェイ再起動待ち) rebooting (リモートアクセスVPNゲートウェイ再起動中) wait_delete_connection (リモートアクセスVPNゲートウェイコネクション切断待ち) deleting_connection (リモートアクセスVPNゲートウェイコネクション切断中) error (エラー)
␣␣␣clientDownloadEndpoint	string	クライアントダウンロードエンドポイント
␣␣␣poolNetworkCidr	string	プールネットワークのCIDR情報
␣␣␣poolNetworkGatewayIpAddress	string	プールネットワークのIPアドレス情報
␣␣␣networkInterfaceSet	-	ネットワークインターフェース情報セット
␣␣␣␣item	-	グローバルネットワークインターフェース情報セット
␣␣␣␣␣networkInterfaceId	string	※空を返却
␣␣␣␣␣subnetId	string	※空を返却
␣␣␣␣␣vpcId	string	※空を返却
␣␣␣␣␣description	string	※空を返却
␣␣␣␣␣ownerId	string	※空を返却
␣␣␣␣␣niftyNetworkId	string	ネットワークユニークID
␣␣␣␣␣niftyNetworkName	string	ネットワーク名
␣␣␣␣␣status	string	ネットワークインターフェースのステータス値: available (利用可能) in-use (使用中) processing (処理中)
␣␣␣␣␣macAddress	string	MACアドレス
␣␣␣␣␣privateIpAddress	string	プライベートIPアドレス
␣␣␣␣␣privateIpAddressV6	string	※空を返却
␣␣␣␣␣privateDnsName	string	※空を返却
␣␣␣␣␣sourceDestCheck	string	※空を返却
␣␣␣␣␣groupSet	string	※空を返却
␣␣␣␣␣attachment	-	ネットワークインターフェースの接続情報
␣␣␣␣␣␣attachmentId	string	※空を返却
␣␣␣␣␣␣deviceIndex	string	デバイス番号
␣␣␣␣␣␣status	string	接続状態値: attaching (接続中) attached (接続済み) detaching (接続解除中) detached (未接続)
␣␣␣␣␣␣attachTime	string	※空を返却
␣␣␣␣␣␣deleteOnTermination	string	サーバー削除時のディスク消去値: true (消去する) false (消去しない)
␣␣␣␣␣␣instanceId	string	※空を返却
␣␣␣␣␣␣instanceOwnerId	string	※空を返却
␣␣␣␣␣association	-	ネットワークインターフェース関連付け情報
␣␣␣␣␣␣allocationId	string	※空を返却
␣␣␣␣␣␣associationId	string	※空を返却
␣␣␣␣␣␣ipOwnerId	string	※空を返却
␣␣␣␣␣␣publicDnsName	string	※空を返却
␣␣␣␣␣␣publicIp	string	IPv4アドレス情報
␣␣␣␣␣␣publicIpV6	string	※空を返却
␣␣␣␣␣privateIpAddressesSet	string	※空を返却
␣␣␣␣␣availabilityZone	string	ゾーン情報
␣␣␣␣␣interfaceType	string	※空を返却
␣␣␣␣␣ipv6AddressesSet	string	※空を返却
␣␣␣␣␣requesterId	string	※空を返却
␣␣␣␣␣requesterManaged	string	※空を返却
␣␣␣␣␣tagSet	string	※空を返却
␣␣␣cipherSuiteSet	-	暗号スイート情報
␣␣␣␣item	-	暗号スイート情報
␣␣␣␣␣cipherSuite	string	暗号スイート
␣␣␣sslCertificateId	string	SSL証明書の発行識別子
␣␣␣caCertificateId	string	CA証明書の発行識別子
␣␣␣authTypeSet	-	認証タイプID情報
␣␣␣␣item	-	認証タイプID情報
␣␣␣␣␣authType	string	認証タイプID
␣␣␣remoteUserSet	-	ユーザー情報
␣␣␣␣item	-	ユーザー情報
␣␣␣␣␣userName	string	ユーザー名
␣␣␣␣␣description	string	※空を返却
␣␣␣groupSet	string	※空を返却
␣␣␣routeTableId	string	※空を返却
␣␣␣routeTableAssociationId	string	※空を返却
␣␣␣isConfiguredNat	string	NATの設定情報値: true (NATの設定済) false (NATの設定無)
␣␣␣clientTunnelMode	string	クライアントトンネルモード
␣␣␣versionInformation	string	リモートアクセスVPNゲートウェイのversion情報
␣␣␣␣isLatest	string	リモートアクセスVPNゲートウェイのversion最新状態
␣␣␣␣version	string	リモートアクセスVPNゲートウェイのversion
␣␣␣createdTime	string	作成日時表示形式:yyyy-mm-ddThh:mi:ss+09:00

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DescribeRemoteAccessVpnGateways
  &RemoteAccessVpnGatewayId.1=ravgw-01234567
  &CommonParams

応答サンプル

    <?xml version="1.0" encoding="UTF-8"?>
<DescribeRemoteAccessVpnGatewaysResponse>
  <requestId>77ab1e2d-dbbf-4f2a-90f6-7e67d4e584f3</requestId>
  <remoteAccessVpnGatewaySet>
    <item>
      <remoteAccessVpnGatewayId>ravgw-01234567</remoteAccessVpnGatewayId>
      <remoteAccessVpnGatewayName>rAVGW01</remoteAccessVpnGatewayName>
      <remoteAccessVpnGatewayType>small</remoteAccessVpnGatewayType>
      <accountingType>1</accountingType>
      <nextMonthAccountingType>1</nextMonthAccountingType>
      <description>&lt;![CDATA[memo]]&gt;</description>
      <availabilityZone>east-12</availabilityZone>
      <status>pending</status>
      <clientDownloadEndpoint/>
      <poolNetworkCidr>192.0.2.0/24</poolNetworkCidr>
      <poolNetworkGatewayIpAddress>192.0.2.1</poolNetworkGatewayIpAddress>
      <networkInterfaceSet>
        <item>
          <networkInterfaceId/>
          <subnetId/>
          <vpcId/>
          <description/>
          <ownerId/>
          <niftyNetworkId>net-COMMON_GLOBAL</niftyNetworkId>
          <niftyNetworkName/>
          <status>in-use</status>
          <macAddress>00:00:5e:00:53:00</macAddress>
          <privateIpAddress/>
          <privateIpAddressV6/>
          <privateDnsName/>
          <sourceDestCheck/>  
          <groupSet/>
          <attachment>
            <attachmentId/>
            <deviceIndex>0</deviceIndex>
            <status>attached</status>
            <attachTime/>
            <deleteOnTermination>true</deleteOnTermination>
            <instanceId/>
            <instanceOwnerId/>
          </attachment>
          <association>
            <allocationId/>
            <associationId/>
            <ipOwnerId/>
            <publicDnsName/>
            <publicIp>203.0.113.1</publicIp>
            <publicIpV6/>
          </association>
          <privateIpAddressesSet/>
          <availabilityZone/>
          <interfaceType/>
          <ipv6AddressesSet/>
          <requesterId/>
          <requesterManaged/>
          <tagSet/>
        </item>
        <item>
          <networkInterfaceId/>
          <subnetId/>
          <vpcId/>
          <description/>
          <ownerId/> 
          <niftyNetworkId>net-0xejwin4</niftyNetworkId>
          <niftyNetworkName>privateLan</niftyNetworkName>
          <status>in-use</status>
          <macAddress>00:00:5e:00:53:01</macAddress>
          <privateIpAddress>192.168.0.1</privateIpAddress>
          <privateIpAddressV6/>
          <privateDnsName/>
          <sourceDestCheck/>
          <groupSet/>
          <attachment>
            <attachmentId/>
            <deviceIndex>0</deviceIndex>
            <status>attached</status>
            <attachTime/>
            <deleteOnTermination>true</deleteOnTermination>
            <instanceId/>
            <instanceOwnerId/>
          </attachment>
          <association>
            <allocationId/>
            <associationId/>
            <ipOwnerId/>
            <publicDnsName/>
            <publicIp/>
            <publicIpV6/>
          </association>
          <privateIpAddressesSet/>
          <availabilityZone/>
          <interfaceType/>
          <ipv6AddressesSet/>
          <requesterId/>
          <requesterManaged/>
          <tagSet/>
        </item>
      </networkInterfaceSet>
      <cipherSuiteSet>
        <item>
          <cipherSuite>AES128-SHA</cipherSuite>
        </item>
      </cipherSuiteSet>
      <sslCertificateId>1234</sslCertificateId>
      <caCertificateId>cac-efba9876</caCertificateId>
      <authTypeSet>
        <item>
          <authType>local</authType>
        </item>
      </authTypeSet>
      <remoteUserSet>
        <item>
          <userName>abc12345</userName>
          <description>&lt;![CDATA[memo]]&gt;</description>
        </item>
      </remoteUserSet>
      <groupSet/>
      <routeTableId/>
      <routeTableAssociationId/>
      <isConfiguredNat>true</isConfiguredNat>
      <clientTunnelMode>split</clientTunnelMode>
      <versionInformation>
        <isLatest>true</isLatest>
        <version>v2.x.x</version>
      </versionInformation>
      <createdTime>2017-07-25T11:22:33+09:00</createdTime>
    </item>
  </remoteAccessVpnGatewaySet>
</DescribeRemoteAccessVpnGatewaysResponse>