Oracle Cloud Infrastructure Compute ClassicのREST API

VPNエンドポイントの更新

put

/vpnendpoint/{name}

このエンドポイントはOracle Cloud Machineでは使用できません。

構成したVPN接続は、VPNトンネルを有効化または無効化したり、その他の接続詳細を変更するために、後で更新できます。

必要なロール: このタスクを実行するには、Compute_Operationsのロールが必要です。このロールが割り当てられていない、または割当てが不明な場合は、システム管理者に連絡してロールがユーザーにOracle Cloud My Servicesで割り当てられるようにしてください。 Oracle Cloudの管理および監視のユーザー・ロールの変更に関する項を参照してください。

リクエスト

サポートされるメディア・タイプ

application/oracle-compute-v3+json

パス・パラメータ

name: string

オブジェクトの、2つの部分からなる名前(/Compute-acme/object)

ヘッダー・パラメータ

Cookie: string

Cookie:ヘッダーは、サービスに対するすべてのリクエストに含まれる必要があります。それをPOST /authenticate/コールに対して受信されたレスポンス内のset-cookieヘッダーの値に設定してください。

リクエスト本文には、更新するVPNエンドポイントの詳細が含まれます。

ルート・スキーマ : VPNEndpoint-put-request

型: object

リクエスト本文には、更新するVPNエンドポイントの詳細が含まれます。

ソースの表示

customer_vpn_gateway: string

顧客VPNデバイスのピア・アドレス
enabled(optional): boolean

VPNエンドポイントを有効化します。 VPN接続を開始するには、trueに設定します。可能な場合は、接続がすぐに確立されます。このオプションを指定しない場合は、VPNエンドポイントが無効になり、接続が確立されません。
name: string

オブジェクトの3つの部分からなる名前(/Compute-acme/object)。
psk: string

事前共有のVPNキー。事前共有キーを入力します。これは、サービスをリクエストしたときに指定した同じキーにしてください。この秘密キーは、ネットワーク・ゲートウェイとOracle Cloudネットワークの間で認証のために共有されます。事前共有キーを含むテキスト・ファイルのフルパスと名前を指定します。テキスト・ファイルの権限レベルが400に設定されていることを確認してください。事前共有VPNキーは256文字を超えることはできません。
reachable_routes: array reachable_routes

このVPNトンネルを介して到達可能な顧客サブネット(CIDRプレフィクス)のリストを指定します。最大20個のIPサブネット・アドレスを指定できます。ドット数値記法でIPv4アドレスを指定します。マスクを使用することもしないことも可能です。

{
    "required":[
        "customer_vpn_gateway",
        "name",
        "psk",
        "reachable_routes"
    ],
    "description":"The request body contains details of the VPN endpoint that you want to update. ",
    "properties":{
        "customer_vpn_gateway":{
            "type":"string",
            "description":"The peer address of customers VPN device"
        },
        "enabled":{
            "type":"boolean",
            "description":"Enables the VPN endpoint. To start a VPN connection, set to <code>true</code>. A connection is established immediately, if possible. If you do not specify this option, the VPN endpoint is disabled and the connection is not established."
        },
        "name":{
            "type":"string",
            "description":"Three-part name of the object (<code><em>/Compute-acme/object</em></code>)."
        },
        "psk":{
            "type":"string",
            "description":"Pre-shared VPN key. Enter the pre-shared key. This must be the same key that you provided when you requested the service. This secret key is shared between your network gateway and the Oracle Cloud network for authentication. Specify the full path and name of the text file that contains the pre-shared key. Ensure that the permission level of the text file is set to 400. The pre-shared VPN key must not exceed 256 characters."
        },
        "reachable_routes":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Specify a list of customers subnets (CIDR prefixes) that are reachable through this VPN tunnel. You can specify a maximum of 20 IP subnet addresses. Specify IPv4 addresses in dot-decimal notation with or without mask."
        }
    }
}

ネストされたスキーマ : reachable_routes

型: array

このVPNトンネルを介して到達可能な顧客サブネット(CIDRプレフィクス)のリストを指定します。最大20個のIPサブネット・アドレスを指定できます。ドット数値記法でIPv4アドレスを指定します。マスクを使用することもしないことも可能です。

ソースの表示

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Specify a list of customers subnets (CIDR prefixes) that are reachable through this VPN tunnel. You can specify a maximum of 20 IP subnet addresses. Specify IPv4 addresses in dot-decimal notation with or without mask."
}

トップに戻る

レスポンス

サポートされるメディア・タイプ

application/oracle-compute-v3+json

200レスポンス

OK。返される可能性のあるその他のHTTPステータス・コードの詳細は、「ステータス・コード」を参照してください。

ヘッダー

set-cookie: string

セッションが拡張された場合、Cookie値が返されます。

ルート・スキーマ : VPNEndpoint-response

型: object

ソースの表示

customer_vpn_gateway(optional): string

Oracle Cloud VPNゲートウェイへの接続に使用するデータ・センターのVPNゲートウェイのIPアドレス。
enabled(optional): boolean

trueは、VPNエンドポイントが使用可能であり、可能な場合は接続がただちに確立されることを示します。
name(optional): string

オブジェクトの、2つの部分からなる名前(/Compute-acme/object)
psk(optional): string

事前共有のVPNキー。
reachable_routes(optional): array reachable_routes

このVPNトンネルを介して到達可能なサブネット(CIDRプレフィクス)のリスト。
status(optional): string

VPNトンネルの現在のステータス。
status_desc(optional): string

VPNトンネルの現在のステータスを説明します。
uri(optional): string

Uniform Resource Identifier
vpn_statistics(optional): object vpn_statistics

許可される追加プロパティ: additionalProperties

VPNトンネルの統計

{
    "properties":{
        "customer_vpn_gateway":{
            "type":"string",
            "description":"IP address of the VPN gateway in your data center through which you want to connect to the Oracle Cloud VPN gateway."
        },
        "enabled":{
            "type":"boolean",
            "description":"<code>true</code> indicates that the VPN endpoint is enabled and a connection is established immediately, if possible."
        },
        "name":{
            "type":"string",
            "description":"Two-part name of the object (<code><em>/Compute-acme/object</em></code>)"
        },
        "psk":{
            "type":"string",
            "description":"Pre-shared VPN key."
        },
        "reachable_routes":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of subnets (CIDR prefixes) that are reachable through this VPN tunnel."
        },
        "status":{
            "type":"string",
            "description":"Current status of the VPN tunnel."
        },
        "status_desc":{
            "type":"string",
            "description":"Describes the current status of the VPN tunnel."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        },
        "vpn_statistics":{
            "additionalProperties":{
                "type":"object"
            },
            "type":"object",
            "description":"Statistics of VPN tunnels"
        }
    }
}

ネストされたスキーマ : reachable_routes

型: array

このVPNトンネルを介して到達可能なサブネット(CIDRプレフィクス)のリスト。

ソースの表示

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of subnets (CIDR prefixes) that are reachable through this VPN tunnel."
}

ネストされたスキーマ : vpn_statistics

型: object

使用可能なその他のプロパティ

ソースの表示

object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "type":"object",
    "description":"Statistics of VPN tunnels"
}

VPNトンネルの統計

ネストされたスキーマ : additionalProperties

型: object

トップに戻る

例

cURLコマンド

次の例では、cURLを使用してRESTリソースに対するPUTリクエストを発行することによって、VPNエンドポイント/Compute-acme/vpn-to-LAを更新する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。

コマンドを1行で入力します。この例では、読みやすくするために改行が使用されています。

curl -i -X PUT
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Content-Type: application/oracle-compute-v3+json"
     -H "Accept: application/oracle-compute-v3+json"
     -d "@requestbody.json"
        https://api-z999.compute.us0.oraclecloud.com/vpnendpoint/Compute-acme/vpn-to-LA

COMPUTE_COOKIEは、前の手順で認証cookieを格納した変数の名前です。認証クッキーの取得および変数への格納の詳細は、認証を参照してください。
api-z999.compute.us0.oraclecloud.comはRESTエンドポイントURLの例です。この値をCompute ClassicサイトのRESTエンドポイントURLに変更します。サイトのRESTエンドポイントURLを見つける方法については、「リクエストの送信」を参照してください。
acmeは値の例です。 acmeをCompute Classicアカウントのアイデンティティ・ドメインIDに置き換えます。

リクエスト本文の例

次の例では、VPNエンドポイントを更新して使用可能にするための、requestbody.jsonファイルのリクエスト本文の内容を示しています。

{
   "psk": "********",
   "name": "/Compute-acme/vpn-to-LA",
   "reachable_routes": "192.168.155.0/24",
   "enabled": true,
   "customer_vpn_gateway": "192.168.111.2"
}

レスポンス本文の例

次の例では、VPNエンドポイント更新時のJSON形式のレスポンス本文を示します。

いくつかの行は、読みやすくするために省略記号(...)で切り捨てられます。

{
   "status": "UP",
   "psk": "********",
   "name": "/Compute-acme/vpn-to-LA",
   "reachable_routes": "192.168.155.0/24",
   "enabled": true,
   "uri": "http://api.oc.example.com/vpnendpoint/Compute-acme/vpn-to-LA",
   "status_desc": "",
   "customer_vpn_gateway": "192.168.111.2"
}

トップに戻る