List VPN services

VPNサービスの一覧を表示します。

URI

/v2.0/vpn/vpnservices

HTTPメソッド

GET

レスポンスステータス

ステータスコード 説明
200 Normal response codes
Unauthorized (401) Error response codes
Forbidden (403) Error response codes

レスポンスボディ(正常系)


{
  "vpnservices": [
    {
      "router_id": "ec8619be-0ba8-4955-8835-3b49ddb76f89",
      "status": "PENDING_CREATE",
      "name": "myservice",
      "admin_state_up": true,
      "subnet_id": "f4fb4528-ed93-467c-a57b-11c7ea9f963e",
      "tenant_id": "ccb81365fe36411a9011e90491fe1330",
      "id": "9faaf49f-dd89-4e39-a8c6-101839aa49bc",
      "description": "",
      "availability_zone": "AZ1"
    }
  ]
}
     

レスポンスボディ(正常系)の説明

要素名 説明
router_id VPNサービスが設定されている仮想ルータのID
status

VPNサービスのステータス

値は次のいずれかです: ACTIVE、DOWN、BUILD、ERROR、PENDING_CREATE、 PENDING_UPDATE、PENDING_DELETE

name VPNサービス名

一意である必要はありません。

admin_state_up VPNサービスの管理状態

"false"(停止中)の場合、ポートはパケットを転送しません。

subnet_id IPSec-VPN、またはSSL-VPNで接続するサブネット
tenant_id VPNサービスの所有者

自分のプロジェクト以外のプロジェクトIDを指定できるユーザーは管理者だけです。

id VPNサービスID
description VPNサービスの説明
availability_zone アベイラビリティゾーン名