API一覧

API一覧

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

API種別 Action 対象 名称 実行
設定 CloneVirtualMachine VM 仮想サーバクローニング 非同期
設定 DescribeVirtualMachine VM 仮想サーバ情報取得  
設定 DisableIPv6 VM 仮想サーバIPv6無効化 非同期
設定 EnableIPv6 VM 仮想サーバIPv6有効化 非同期
設定 GetVirtualMachineStatus VM 仮想サーバ状態取得  
設定 GetVirtualMachineStatusList VM 仮想サーバ状態一覧取得  
設定 ImportRootSshPublicKey VM 仮想サーバSSH公開鍵追加 非同期
設定 InitializeVirtualMachine VM 仮想サーバOS初期化 非同期
設定 RebootVirtualMachine VM 仮想サーバ再起動 非同期
設定 ResetIptables VM 仮想サーバiptables設定初期化 非同期
設定 ResetNetworkConfiguration VM 仮想サーバネットワーク設定初期化 非同期
設定 ResetSshdConfiguration VM 仮想サーバSSH設定初期化 非同期
設定 StartVirtualMachine VM 仮想サーバ起動 非同期
設定 StopVirtualMachine VM 仮想サーバ停止 非同期
契約 AddCloneVirtualMachines VM 仮想サーバ追加申込(クローニング) 非同期
契約 AddDiskOption VM 追加ディスクオプション追加申込 非同期
契約 AddGlobalAddressOption VM 追加グローバルアドレスオプション追加申込 非同期
契約 AddVirtualMachines VM 仮想サーバ追加申込 非同期
契約 ChangeVirtualMachineType VM 仮想サーバ品目変更申込 非同期
契約 DeleteDiskOption VM 追加ディスクオプション解約申込  
契約 DeleteGlobalAddressOption VM 追加グローバルアドレスオプション解約申込  
契約 DeleteVirtualMachine VM 仮想サーバ解約申込  
設定 AddLbNode FW/LB LBノード追加  
設定 AddLbPool FW/LB LBプール追加  
設定 AddLbVirtualServer FW/LB LB仮想サービス追加  
設定 AddVirtualIpAddress FW/LB LBグローバルアドレス追加  
設定 AttachFwLb FW/LB 仮想サーバFW+LB接続 非同期
設定 DeleteLbNode FW/LB LBノード削除  
設定 DeleteLbPool FW/LB LBプール削除  
設定 DeleteLbVirtualServer FW/LB LB仮想サービス削除  
設定 DeleteVirtualIpAddress FW/LB LBグローバルアドレス削除  
設定 DescribeFw FW/LB FW情報取得  
設定 DescribeLb FW/LB LB情報取得  
設定 DetachFwLb FW/LB 仮想サーバFW+LB切断 非同期
設定 GetFilteringRuleList FW/LB フィルタリングルール情報取得  
設定 GetLbHostList FW/LB LBホスト情報取得  
設定 GetLbPool FW/LB LBプール情報取得  
設定 GetLbStatus FW/LB LB状態取得  
設定 GetLbVirtualServer FW/LB LB仮想サービス情報取得  
設定 GetSnatRuleList FW/LB SNAT情報取得  
設定 SetFilteringRuleList FW/LB フィルタリングルール一括設定  
設定 SetLbNode FW/LB LBノード変更  
設定 SetLbPool FW/LB LBプール一括設定  
設定 SetLbPoolName FW/LB LBプール名称変更  
設定 SetLbVirtualServer FW/LB LB仮想サービス変更  
設定 SetLbVirtualServerName FW/LB LB仮想サービス名称変更  
設定 SetSnatRuleList FW/LB SNAT一括設定  
設定 SetVirtualIpAddressName FW/LB LBグローバルアドレス名称変更  
契約 AddFwLbOption FW/LB FW+LBオプション追加申込 非同期
契約 ChangeFwLbOptionType FW/LB FW+LBオプションタイプ変更申込 非同期
契約 DeleteFwLbOption FW/LB FW+LBオプション解約申込  
設定 AttachVlan VLAN 仮想サーバVLAN接続 非同期
設定 DetachVlan VLAN 仮想サーバVLAN切断 非同期
契約 AddVlanOption VLAN VLANオプション追加申込 非同期
契約 DeleteVlanOption VLAN VLANオプション解約申込  
設定 GetDomainNameByIpAddress VM, FW/LB ドメイン名取得  
設定 ResetDomainNameByIpAddress VM, FW/LB ドメイン名初期化  
設定 SetDomainNameByIpAddress VM, FW/LB ドメイン名設定  
設定 SetLabel 契約, VM, FW/LB ラベル設定  
契約 GetContractInformation 契約 契約情報取得  
契約 GetContractStatus 契約 契約状態取得  
その他 GetServiceCodeList 契約 サービスコード一覧取得  
その他 GetGpServiceCodeList 契約 マネージメントサービス一覧取得  
その他 Echo テスト用 APIの疎通テスト (Echo)  

APIバージョン

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

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

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

APIVersion 利用開始日 利用終了日 備考
20130901 2013年9月24日 未定 初期リリース版

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

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

JSON表記

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

XML表記

XML
<?xml version="1.0" encoding="UTF-8"?>
<SampleApiResponse>
    <Param1>abcdefg</Param1>
    <Param2>
        <ParamA>pqr</ParamA>
        <ParamB>xyz</ParamB>
    </Param2>
    <Param3>
        <ParamC>123</ParamC>
    </Param3>
    <Param3>
        <ParamC>987</ParamC>
    </Param3>
</SampleApiResponse>
フィールド タイプ 意味
SampleApiResponse.Param1
String 単純な値
SampleApiResponse.Param2
Object 内部に複数の値を含む連想配列
SampleApiResponse.Param2.ParamA
String 構造体に含まれる単純な値
SampleApiResponse.Param2.ParamB
String 構造体に含まれる単純な値
SampleApiResponse.Param3
Array 内部に複数の値を含む単純配列
SampleApiResponse.Param3.ParamC
String 配列に含まれる単純な値