GMOクラウド Public APIリファレンス

サポートトップ » GMOクラウド Public トップ » APIリファレンス

APIコンソール

APIポータルサイト内画面上部の、[APIコンソール]メニューよりアクセスできます。APIコンソールでは、API特有の複雑な計算を行うことなくリクエストを算出できます。また、リクエスト結果(レスポンスやステータス)も確認することができる為、開発の時間を大幅に短縮できることが期待できます。

注意事項

  • APIコンソール上で実行した機能は、お客さまの運用環境に反映されます。現在運用されている仮想サーバーに影響のある機能を実行される場合は、十分にご注意ください。
  • 実行結果に伴う影響(仮想サーバーの削除や各種設定変更、また課金など)でお客さま、または第三者に生じた損害については、当社の過失の有無やその程度に関わらず、一切の責任は負いかねますのでご了承ください。
  • APIポータルの利用方法についてはサポートいたしますが、実行結果の内容やエラーの原因等についてはサポート範囲外となります。各種参考書籍などをご参照くださいますようお願いいたします。

STEP1 APIコマンドの実行

APIコマンドの実行は下記画面の必要情報を入力の上、[API実行]をクリックしてください。

クラウドゾーン 実行先のクラウドゾーンを選択します。契約していないクラウドゾーンは選択できません。
実行機能名 実行機能名を入力します。どのような機能があるのか、また機能名は何かはAPIリファレンスガイドをご参照ください。(参照:APIリファレンスガイド
リクエストパラメータ リクエストパラメータを入力します。リクエストパラメータは各実行機能によって異なりますので、詳細はAPIリファレンスガイドをご参照ください。(参照:APIリファレンスガイド

[必須項目の確認]
実行する機能によっては、リクエストパラメータを必ず入力しなければなりません。各実行機能の必須リクエストパラメータは、以下いずれかの方法で確認することができます。

  • 実行機能名を入力後、[必須項目]をクリック
  • リクエストパラメータ欄に「*」を入力

なお、既に入力されている[Version=○]は、全ての実行機能に必要なリクエストパラメータです。削除されないようご注意ください。

ポイント① マニュアルを活用!

[API実行]ボタンの並びに、[マニュアル]ボタンがあります。実行機能名を入力後[マニュアル]ボタンをクリックすると、右画面にマニュアルが表示されます。サポートサイトから該当の実行機能名を探さなくても、APIポータルガイドで完結することが可能です。

STEP2 API実行結果

APIを実行すると、下記画面に実行結果が表示されます。

A. リクエスト API実行結果のリクエスト情報です。
B. ステータス API実行結果のステータス情報です。ステータスは下記を参照してください。
C. レスポンス API実行後のレスポンス情報です。

ポイント② メモ機能を活用!

実行結果を、メモ機能で保存することが可能です。結果を保存したい場合は「+」をクリック、削除する場合は該当タブの「-」をクリックしてください。
(ページの再読み込みやログアウトすると、保存したメモはリフレッシュされます。)

STEP3 トランザクションログの確認

実行したAPIのトランザクションログが確認できます。タスクは実行命令が到達した順に走るのでご注意ください。タスクの滞留や、ロック状態(※)を防ぐため、各タスクが完了した後に次のAPIを実行してください。

※ロック状態とは、仮想サーバーの連続操作による、データの不整合を防ぐための排他制御の一種となります。ロック状態となった場合には、サポート窓口まで解除申請をしてください。(参照:仮想サーバーのロック解除について

このガイドで問題は解決しましたか?

ご回答ありがとうございました。

引き続きGMOクラウド サポートサイトをご利用ください。

ご回答ありがとうございました。

GMOクラウド Public サポートまでお問い合わせください。

お問い合わせ