サポートトップ » GMOクラウド Public トップ » APIリファレンス
APIポータルサイト内画面上部の、[APIコンソール]メニューよりアクセスできます。APIコンソールでは、API特有の複雑な計算を行うことなくリクエストを算出できます。また、リクエスト結果（レスポンスやステータス）も確認することができる為、開発の時間を大幅に短縮できることが期待できます。
APIコマンドの実行は下記画面の必要情報を入力の上、[API実行]をクリックしてください。
| クラウドゾーン | 実行先のクラウドゾーンを選択します。契約していないクラウドゾーンは選択できません。 |
|---|---|
| 実行機能名 | 実行機能名を入力します。どのような機能があるのか、また機能名は何かはAPIリファレンスガイドをご参照ください。（参照：APIリファレンスガイド） |
| リクエストパラメータ | リクエストパラメータを入力します。リクエストパラメータは各実行機能によって異なりますので、詳細はAPIリファレンスガイドをご参照ください。（参照：APIリファレンスガイド） [必須項目の確認] 実行する機能によっては、リクエストパラメータを必ず入力しなければなりません。各実行機能の必須リクエストパラメータは、以下いずれかの方法で確認することができます。
なお、既に入力されている[Version=○]は、全ての実行機能に必要なリクエストパラメータです。削除されないようご注意ください。 |
[API実行]ボタンの並びに、[マニュアル]ボタンがあります。実行機能名を入力後[マニュアル]ボタンをクリックすると、右画面にマニュアルが表示されます。サポートサイトから該当の実行機能名を探さなくても、APIポータルガイドで完結することが可能です。
APIを実行すると、下記画面に実行結果が表示されます。
| A. リクエスト | API実行結果のリクエスト情報です。 |
|---|---|
| B. ステータス | API実行結果のステータス情報です。ステータスは下記を参照してください。 |
| C. レスポンス | API実行後のレスポンス情報です。 |
実行結果を、メモ機能で保存することが可能です。結果を保存したい場合は「+」をクリック、削除する場合は該当タブの「-」をクリックしてください。
（ページの再読み込みやログアウトすると、保存したメモはリフレッシュされます。）
実行したAPIのトランザクションログが確認できます。タスクは実行命令が到達した順に走るのでご注意ください。タスクの滞留や、ロック状態（※）を防ぐため、各タスクが完了した後に次のAPIを実行してください。
※ロック状態とは、仮想サーバーの連続操作による、データの不整合を防ぐための排他制御の一種となります。ロック状態となった場合には、サポート窓口まで解除申請をしてください。（参照：仮想サーバーのロック解除について）
