Alibaba Cloud API オペレーションのオンラインデバッグ - OpenAPI Explorer

OpenAPI Explorer で Alibaba Cloud API オペレーションをオンラインでデバッグする方法について説明します。

Alibaba Cloud アカウントの作成

API 呼び出しには Alibaba Cloud アカウントが必要です。お持ちでない場合は、Alibaba Cloud official website で登録します。

Alibaba Cloud サービスの有効化

使用する Alibaba Cloud サービスを有効化します。次の例では Short Message Service (SMS) を使用します。

ユーザーセンターに移動し、Short Message Service を検索して、[Activate] をクリックします。
サービスコンソール (例：SMS console) に移動し、[Activate] をクリックします。

重要

API オペレーションを呼び出す前に、対象の Alibaba Cloud サービスを有効化する必要があります。

API オペレーションのオンラインデバッグ

OpenAPI Explorer にサインインし、ECS などのアクティベートされた Alibaba Cloud サービスを選択して、[デバッグ] をクリックします。

ECS の DescribeInstanceTypeFamilies など、デバッグする API 操作を選択します。[パラメーター] セクションで、[ドキュメント] タブの記載に従って値を入力し、[呼び出し開始] をクリックします。OpenAPI オンラインデバッグ。

レスポンス

[レスポンス] タブには、[HTTP ステータスコード] とコールによって返されたデータが表示されます。

このタブには、[Request Header] と [Response Header] の情報も表示されます。

成功した呼び出し

成功した呼び出しでは、HTTP ステータスコード 200 と JSON 形式のレスポンスが返されます。各パラメーターは、DescribeInstanceTypeFamilies のリファレンスなど、API ドキュメントに記載されています。

失敗した呼び出し

失敗した呼び出しでは、4xx 台の HTTP ステータスコードが返されます。Alibaba Cloud API は、標準ゲートウェイを使用しない一部のサービスを除き、統一されたエラーレスポンス構造を使用します。次の例は、ECS の RunInstances API のエラーフォーマットは次のとおりです：

{
  "RequestId": "7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "Message": "The specified endpoint cant operate this region. Please use API DescribeRegions to get the appropriate endpoint, or upgrade your SDK to latest version.(from POP)",
  "Recommend": "https://api.aliyun.com/troubleshoot?q=InvalidOperation.NotSupportedEndpoint&product=Ecs&requestId=7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "HostId": "ecs-cn-hangzhou.aliyuncs.com",
  "Code": "InvalidOperation.NotSupportedEndpoint"
}

パラメーター	説明
RequestId	グローバルで一意のリクエスト ID です。問題を特定するために、この `RequestId` を Alibaba Cloud サポートに提示してください。
HostId	エラーが発生したサービスのエンドポイントです。この例では、China (Hangzhou) リージョンの ECS エンドポイントです。
Code	エラー種別を示す短い識別子です。解決策については、このコードを Alibaba Cloud ドキュメントで確認してください。この例では、エンドポイントが対象リージョンをサポートしていません。
Message	詳細なエラーメッセージです。この例では、エンドポイントが選択したリージョンをサポートしていません。有効なエンドポイントを確認するには、`DescribeRegions` API を使用してください。
Recommend	診断用 URL です。このリンクを開くと、OpenAPI Troubleshoot に移動して解決策を確認できます。

エラーのトラブルシューティングには、OpenAPI Troubleshoot を使用してください。

SDK サンプルコード

[SDK サンプルコード] タブで、[SDK バージョン] と言語を選択し、[サンプルを実行] をクリックします。

また、[View Version Differences] をクリックして SDK バージョンを比較したり、[Download Full Project] をクリックしてコードをダウンロードしたり、[Generate Example in Common Mode] を切り替えて生成モードを変更したりできます。

CLI の例

呼び出し履歴

[呼び出し履歴] タブには、過去の API 呼び出しが一覧表示されます。パラメーターを確認し、[再デバッグ] をクリックすると、呼び出しを再実行できます。呼び出しの [ステータス] が失敗した場合、[診断] を使用して原因を特定できます。

[CLI の例] タブで、実行ボタンをクリックしてコマンドをオンラインでデバッグします。

エラーコード

[エラーコード] タブには、考えられるエラーとその説明が一覧表示されます。[診断] をクリックすると、関連ドキュメント、フォーラムディスカッション、サポートを提供する診断ページが開きます。

たとえば、無効な [RegionId] を入力すると、HTTP ステータスコード 404、エラーコード InvalidRegionId.NotFound、およびメッセージ The RegionId provided does not exist in our records. が返されます。