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

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

Alibaba Cloud アカウントの作成

API 呼び出しには Alibaba Cloud アカウントが必要です。アカウントをお持ちでない場合は、Alibaba Cloud 公式サイトでアカウント登録を行ってください。

Alibaba Cloud サービスの有効化

使用する Alibaba Cloud サービスを有効化します。次の例では、ショートメッセージサービス (SMS) を使用します。

ユーザーセンターにアクセスし、ショートメッセージサービスを検索して [Activate] をクリックします。
SMS コンソールなどのサービスコンソールにアクセスし、[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 オペレーションのエラー形式を示しています。

{
  "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.alibabacloud.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	エラーが発生したサービスエンドポイントです。この例では、中国 (杭州) リージョンの 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 例

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

呼び出し履歴

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

エラーコード

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

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