- HOME
- 開発者ガイドブック(APIリファレンス)
- Premium/Value/Flexible
- 提供API一覧
提供API一覧
KDDIで検証を行い、現在公開しているAPIの一覧です。
提供API
| No | カテゴリ | APIコマンド | 内容 | KDDI作成API | 提供開始日 |
| 1-1 | Virtual Machine | rebootVirtualMachine | 仮想サーバーの再起動 | 2015/07/01 | |
| 1-2 | Virtual Machine | listVirtualMachines | 仮想サーバーの一覧取得 | 2015/07/01 | |
| 1-3 | Virtual Machine | deployValueVirtualMachine | Value仮想サーバーの作成 | ○ | 2016/06/10 |
| 1-4 | Virtual Machine | deployFlexibleVirtualMachine | Flexible仮想サーバーの作成 | ○ | 2023/04/14 |
| 1-5 | Virtual Machine | deployPremiumVirtualMachine | Premium仮想サーバの作成 | ○ | 2016/06/10 |
| 1-6 | Virtual Machine | stopVirtualMachine | 仮想サーバーの停止 | 2016/06/10 | |
| 1-7 | Virtual Machine | startVirtualMachine | 仮想サーバーの起動 | ○ | 2016/06/10 |
| 1-8 | Virtual Machine | destroyVirtualMachine | 仮想サーバーの削除 | 2016/06/10 | |
| 1-9 | Virtual Machine | resetPasswordForVirtualMachine | 仮想サーバーのパスワードをリセット | 2016/10/25 | |
| 1-10 | Virtual Machine | changeServiceForVirtualMachine | 仮想サーバーのサービス変更を実施。拡張・縮小が可能(サーバ停止が必要) | 2016/10/25 | |
| 1-11 | Virtual Machine | scaleVirtualMachine | 仮想サーバーのサービス変更を実施。拡張のみ可能(サーバ停止は不要) | 2016/10/25 | |
| 2-1 | Volume | listVolumes | ボリュームの一覧取得 | 2015/07/01 | |
| 2-2 | Volume | attachVolume | 仮想サーバーにボリュームをアタッチ | 2016/10/25 | |
| 2-3 | Volume | detachVolume | 仮想サーバーからボリュームをデタッチ | 2016/10/25 | |
| 2-4 | Volume | deleteVolume | ボリュームを削除 | 2016/10/25 | |
| 2-5 | Volume | resizeVolume | ボリュームサイズを拡張 | 2016/10/25 | |
| 2-6 | Volume | createVolume | ボリュームの作成 | 2017/03/16 | |
| 3-1 | Guest OS | listOsTypes | OSタイプの一覧取得 | 2015/07/01 | |
| 4-1 | Template | createTemplate | テンプレートの作成 | 2015/07/01 | |
| 4-2 | Template | deleteTemplate | テンプレートの削除 | 2015/07/01 | |
| 4-3 | Template | listTemplates | テンプレートの一覧取得 | 2015/07/01 | |
| 4-4 | Template | getUploadParamsForTemplate | テンプレートファイルの登録 | 2021/10/27 | |
| 4-5 | Template | updateTemplate | テンプレーの登録情報を更新 | 2017/09/28 | |
| 4-6 | Template | updateTemplatePermissions | テンプレートの公開レベルの変更 | 2017/09/28 | |
| 4-7 | Template | listTemplatePermissions | テンプレートのパーミッション情報表示 | 2017/09/28 | |
| 5-1 | Snapshot | createSnapshot | スナップショットの作成 | 2015/07/01 | |
| 5-2 | Snapshot | deleteSnapshot | スナップショットの削除 | 2015/07/01 | |
| 5-3 | Snapshot | listSnapshots | スナップショットの一覧取得 | 2015/07/01 | |
| 5-4 | Snapshot | createVMSnapshot | VMスナップショットの作成 | 2016/06/10 | |
| 5-5 | Snapshot | revertToVMSnapshot | VMスナップショットのリストア | 2016/06/10 | |
| 5-6 | Snapshot | deleteVMSnapshot | VMスナップショットの削除 | 2016/06/10 | |
| 5-7 | Snapshot | listSnapshotPolicies | 定期スナップショットの設定情報を取得 | 2016/10/25 | |
| 5-8 | Snapshot | createSnapshotPolicy | 定期スナップショットの設定 | 2017/09/28 | |
| 5-9 | Snapshot | deleteSnapshotPolicies | 定期スナップショットの設定解除 | 2017/09/28 | |
| 6-1 | Event | listEvents | イベントの一覧取得 | 2015/07/01 | |
| 6-2 | Event | listEventTypes | イベントタイプの一覧取得 | 2015/07/01 | |
| 7-1 | Async job | queryAsyncJobResult | 非同期実行APIの実行状況取得(KDDI作成APIは除く) | 2015/07/01 | |
| 7-2 | Async job | listAsyncJobs | 非同期実行APIの一覧取得 | 2015/07/01 | |
| 8-1 | Nic | addIpToNic | NICにセカンダリIPアドレス（IPv4）を割り当て | 2016/06/10 | |
| 8-2 | Nic | removeIpFromNic | NICからセカンダリIPを開放 | 2016/06/10 | |
| 8-3 | Nic | listNics | NICの一覧取得 | 2016/06/10 | |
| 8-4 | Nic | listPublicIpAddresses | パブリックIPアドレス情報を取得 | 2016/10/25 | |
| 8-5 | Nic | addNicToVirtualMachine | 仮想サーバーにNICを追加 | 2016/10/25 | |
| 8-6 | Nic | removeNicFromVirtualMachine | 仮想サーバーからNICを削除 | 2016/10/25 | |
| 8-7 | Nic | associateIpAddress | IPアドレスを取得 | 2016/10/25 | |
| 8-8 | Nic | disassociateIpAddress | IPアドレスを解放 | 2016/10/25 | |
| 9-1 | Job | queryExAsyncJobResult | 非同期実行APIの実行状況取得(KDDI作成APIが対象) | ○ | 2016/06/10 |
| 10-1 | Host | listDistributionGroups | 分散収容オプションの割り当て状態の確認 | ○ | 2016/06/10 |
| 10-2 | Host | listPremiumHosts | Premiumホスト情報を取得 | 2016/10/25 | |
| 10-3 | Host | listPremiumVirtualMachines | Premiumホスト上の仮想サーバの一覧を取得 | 2016/10/25 | |
| 10-4 | Host | addPremiumHosts | Premiumホストを取得 | 2016/10/25 | |
| 10-5 | Host | removePremiumHost | Premiumホストを削除 | 2016/10/25 | |
| 11-1 | Account/Domain | listUsers | 登録されているユーザーアカウントの一覧を取得 | 2016/10/25 | |
| 11-2 | Account/Domain | listNetworks | ネットワーク一覧の取得 | 2016/10/25 | |
| 11-3 | Account/Domain | listServiceOfferings | サービスオファリング一覧を取得します | 2016/10/25 | |
| 11-4 | Account/Domain | listDiskOfferings | ディスクオファリングの一覧を取得 | 2016/10/25 | |
| 11-5 | Account/Domain | listZones | 利用可能なゾーン情報を取得 | 2016/10/25 | |
| 12-1 | Firewall | listFirewallRules | 標準ファイアーウォールルールを取得 | 2016/10/25 | |
| 12-2 | Firewall | createFirewallRule | 標準ファイアーウォールルールを作成 | 2016/10/25 | |
| 12-3 | Firewall | deleteFirewallRule | 標準ファイアーウォールルールを削除 | 2016/10/25 | |
| 12-4 | Firewall | enableStaticNat | スタティックNATの設定を実施 | 2016/10/25 | |
| 12-5 | Firewall | disableStaticNat | スタティックNATの設定を削除 | 2016/10/25 | |
| 13-1 | NAT/PortFoward | listPortForwardingRules | ポート転送ルールの設定一覧を取得 | 2016/10/25 | |
| 13-2 | NAT/PortFoward | createPortForwardingRule | ポート転送ルールを作成 | 2016/10/25 | |
| 13-3 | NAT/PortFoward | deletePortForwardingRule | ポート転送ルールを削除 | 2016/10/25 | |
| 14-1 | VMSnapshot | listVMSnapshot | VMSnapshotの情報を取得 | 2016/10/25 | |
| 15-1 | LoadBalancer | createLoadBalancerRule | 標準ロードバランサーの設定を作成 | 2016/10/25 | |
| 15-2 | LoadBalancer | deleteLoadBalancerRule | 標準ロードバランサーの設定を削除 | 2016/10/25 | |
| 15-3 | LoadBalancer | removeFromLoadBalancerRule | 標準ロードバランサーから仮想サーバを取り外す | 2016/10/25 | |
| 15-4 | LoadBalancer | assignToLoadBalancerRule | 標準ロードバランサーに仮想サーバを割り当てます | 2016/10/25 | |
| 15-5 | LoadBalancer | createLBStickinessPolicy | 標準ロードバランサーのスティッキー設定を作成 | 2016/10/25 | |
| 15-6 | LoadBalancer | deleteLBStickinessPolicy | 標準ロードバランサーのスティッキー設定を削除 | 2016/10/25 | |
| 15-7 | LoadBalancer | listLoadBalancerRules | 標準ロードバランサーの設定情報を取得 | 2016/10/25 | |
| 15-8 | LoadBalancer | listLBStickinessPolicies | 標準ロードバランサーのスティッキー設定を取得 | 2016/10/25 | |
| 15-9 | LoadBalancer | listLoadBalancerRuleInstances | 標準ロードバランサーに所属する仮想サーバ情報を取得 | 2016/10/25 | |
| 15-10 | LoadBalancer | updateLoadBalancerRule | 標準ロードバランサー設定を更新 | 2016/10/25 | |
| 16-1 | ISO | listIsos | ISO情報の一覧を取得 | 2016/10/25 | |
| 16-2 | ISO | attachIso | ISOを仮想サーバにアタッチ | 2016/10/25 | |
| 16-3 | ISO | detachIso | ISOを仮想サーバからデタッチ | 2016/10/25 | |
| 16-4 | ISO | registerIso | ISOファイルの登録 | 2017/09/28 | |
| 16-5 | ISO | updateIso | ISO情報のアップデート | 2017/09/28 | |
| 16-6 | ISO | deleteIso | 登録したISOの削除 | 2017/09/28 | |
| 16-7 | ISO | updateIsoPermissions | ISOの公開レベルを変更 | 2017/09/28 | |
| 16-8 | ISO | listIsoPermissions | ISOのパーミッション情報を表示 | 2017/09/28 | |
| 17-1 | Tags | createTags | KCPS管理のリソースにタグ情報を付加 | 2017/09/28 | |
| 17-2 | Tags | deleteTags | KCPS管理下のリソースに付加されたタグ情報を削除 | 2017/09/28 | |
| 17-3 | Tags | listTags | KCPS管理下のリソースに付与されているタグ情報を表示 | 2017/09/28 |
・APIコマンド引数として、「%」は使用しないでください。
・API実行後、JOBが正常に実行されたことをqueryAsyncJobResultやqueryExAsyncJobResultを用いて確認してください。
・必須パラメータ以外の引数を誤って実行した場合、エラーにはならず、その引数は無視されてAPIコマンドが実行されます。
・KDDI作成APIとは、CloudStackで標準提供されているAPIではなく、KDDIが独自で作成したAPIとなります。
・提供APIの実行時エラーについては、APIレスポンスエラー一覧を参照のうえ、APIエラー発生時切り分けフローに沿って対応をお願い致します。