Alibaba Cloud API は、プログラミングインターフェイスを使用してさまざまな Alibaba Cloud サービスを管理および呼び出すことができる強力なツールセットです。たとえば、Elastic Compute Service ( ECS )、Object Storage Service ( OSS )、および Short Message Service ( SMS ) の API 操作を呼び出すことができます。このトピックでは、API 操作をオンラインでデバッグする方法について説明します。
Alibaba Cloud アカウントを作成する
APIオペレーションを呼び出すには、Alibaba Cloudアカウントを使用する必要があります。 Alibaba Cloudアカウントをお持ちでない場合は、[Alibaba Cloud公式ウェブサイト] にアクセスして作成してください。
Alibaba Cloud サービスをアクティブ化する
次のいずれかの方法を使用して、必要な Alibaba Cloud サービスをアクティブ化できます。この例では、SMS がアクティブ化されています。
ユーザーセンター コンソールにログオンします。 SMS を検索し、SMS を選択して、[アクティブ化] をクリックして SMS をアクティブ化します。
SMS の購入ページに移動し、サービスをアクティブ化します。
Alibaba Cloud サービスの API 操作は、サービスをアクティブ化した後にのみ呼び出すことができます。
API 操作をオンラインでデバッグする
OpenAPI Explorer にログオンします。トップナビゲーションバーで、ポインターを [クラウド製品] に移動し、管理するアクティブ化された Alibaba Cloud サービスを選択します。この例では、ECS が選択されています。サービスページの右上隅にある [デバッグ] をクリックします。
デバッグページで、デバッグする API 操作を選択します。この例では、DescribeInstanceTypeFamilies 操作が選択されています。[パラメーター] タブの [ドキュメント] タブの API リファレンスに基づいて必要なパラメーターを構成し、[呼び出しを開始] をクリックします。パラメーター値が有効であることを確認してください。詳細については、「OpenAPI オンラインデバッグ」をご参照ください。
呼び出し結果を表示する
API 操作を呼び出した後、[レスポンス] タブで呼び出し結果を表示できます。[HTTP ステータスコード] と API 呼び出しに対して返されたデータを表示できます。
成功した API 呼び出し
ほとんどの場合、成功した API 呼び出しに対して返される HTTP ステータスコードは 200 です。返されるデータは、通常 JSON 形式です。対応する API リファレンスで各レスポンスパラメーターの意味を確認できます。次の図は、ECS の DescribeInstanceTypeFamilies 操作の成功した呼び出しに対して返されたレスポンスパラメーターを示しています。
失敗した API 呼び出し
ほとんどの場合、失敗した API 呼び出しに対して返される HTTP ステータスコードは 4xx です。失敗した 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)", // 指定されたエンドポイントは、このリージョンを操作できません。API DescribeRegions を使用して適切なエンドポイントを取得するか、SDK を最新バージョンにアップグレードしてください。(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 | リクエストの GUID。特定の API 操作の呼び出しを追跡および識別するために使用されます。失敗した API 呼び出しについて Alibaba Cloud テクニカルサポートに連絡する必要がある場合は、API 操作のリクエスト ID を提供して、エラーのコンテキストを効率的に特定できるようにします。 |
HostId | エラーが発生したサーバーまたはサービスエンドポイントのホスト ID。この例では、中国 (杭州) リージョンにある ECS インスタンスのエンドポイントでエラーが発生しました。 |
Code | エラーコード。エラーコードは、エラーの短く正確な説明を示します。開発者は、エラーコードを使用して、Alibaba Cloud ドキュメントでコードの意味と解決策を見つけることができます。この例では、エラーコードは、指定されたエンドポイントが宛先リージョンでサポートされていないため、API 操作の呼び出しに失敗したことを示しています。 |
Message | エラーメッセージ。この例では、エラーメッセージは、指定されたエンドポイントが宛先リージョンでサポートされていないことを示しています。有効なエンドポイントを照会するには、 |
Recommend | 対応するエラー診断の URL。URL を直接コピーして OpenAPI 問題診断 ページに移動し、解決策を入手できます。 |
トラブルシューティングの詳細については、「OpenAPI エラー診断」をご参照ください。
SDK サンプルコードを実行する
API 操作の SDK サンプルコードを実行するには、次の操作を実行します。[SDK サンプルコード] タブで、[SDK バージョン] を選択し、言語を選択して、[例] をクリックします。
CLI コマンドを実行する
Cloud Shell で CLI コマンドを実行して API 操作を呼び出すには、[CLI の例] タブの右上隅にある [CloudShell でコマンドを実行] アイコンをクリックします。
呼び出し履歴を表示する
API 操作の呼び出し履歴は、[呼び出し履歴] タブで表示できます。呼び出しのパラメーターを表示するには、呼び出しの [アクション] 列の [呼び出しパラメーターの表示] をクリックします。API 操作をデバッグするために呼び出しを再度開始するには、呼び出しの [アクション] 列の [再デバッグ] をクリックします。呼び出しの [ステータス] が失敗の場合は、[アクション] 列の [診断] をクリックして、呼び出しの失敗の原因を診断します。
エラーコードを表示する
API 呼び出しで返される可能性のあるエラーコードと各エラーコードの説明は、[エラーコード] タブで表示できます。エラーコードの [アクション] 列の [診断] をクリックすると、対応するエラーの OpenAPI 問題診断ページに移動できます。次に、関連ドキュメントを照会したり、関連フォーラムにアクセスしたり、テクニカルサポートに連絡してエラーのトラブルシューティングを行うことができます。
