API一覧

P2PUB-APIでは以下のAPIが利用できます。

• API種別: API種別 (参考: AccessKey API種別とAccessKey)
• URI: リクエストパラメータのURIに指定する値
• 対象: APIの操作対象
  • VM: 仮想サーバ
  • FW/LB: FW+LBオプション
  • VLAN: VLANオプション
  • 契約: 契約情報の参照など
• 名称: APIの名前
• 実行: APIの実行が非同期かどうか (参考: API利用方法 非同期に処理されるAPI)

APIバージョン

P2PUB-APIで提供するAPI群にはバージョンが設定されています。バージョンによって一部のパラメータや、挙動が変化する場合があります

APIをリクエストする際に、APIVersionパラメータを指定することで、どのバージョンのAPIを実行するかを指定することができます。

現在指定可能なAPIVersionは以下の通りです。

API詳細における凡例 (レスポンス)

各API一覧ページでは、レスポンスの説明に以下のような表記を使用します。

JSON表記

{
    "SampleApiResponse": {
        "Param1": "abcdefg",
        "Param2": {
            "ParamA": "pqr",
            "ParamB": "xyz"
        },
        "Param3": [
            {
                "ParamC": "123"
            },
            {
                "ParamC": "987"
            }
        ]
    }
}

SampleApiResponse.Param1

SampleApiResponse.Param2

SampleApiResponse.Param2.ParamA

SampleApiResponse.Param2.ParamB

SampleApiResponse.Param3

SampleApiResponse.Param3.ParamC