:OpenAPIの使用

開発者は、API操作を呼び出すときに次の情報に注意を払う必要があります。

1. 呼び出しアドレス

2. ログオンが必要かどうか

3. 承認が必要かどうか

4. 呼び出し方法

5. 返される結果

Alibaba Cloud APIと同じです。

Alibaba Cloud API操作の呼び出しシーケンス図

次の図は、ユーザーがクライアントからAPIリクエストを開始してから、ユーザーがAlibaba Cloudサービスからレスポンスを受信するまでの、イベントの完全なシーケンスを示しています。

1. ユーザーはHTTPリクエストを開始し、ビジネスサーバーによって提供される操作を呼び出します。 たとえば、Elastic Compute Service (ECS) インスタンスのステータスを照会するために使用されます。

2. ビジネスサーバは、ビジネスクライアントから要求を受信し、パラメータの有効性を検証する。 サーバーはAPIドキュメントに基づいてパラメーターを整理し、リクエストに署名します。 Alibaba Cloud SDKを使用してAPI操作を呼び出す場合、SDKにはすでにリクエスト署名ロジックが含まれているため、ビジネスサーバーはリクエストに署名する必要はありません。

3. ビジネスサーバーは、APIゲートウェイのエンドポイントにアクセスする要求を開始します。

4. APIゲートウェイは、ビジネスサーバーから要求を受信し、署名を検証し、呼び出し元のIDを解析し、認証を実行します。

5. 認証が成功すると、リクエストは内部サービスアドレスに転送されます。

6. クラウド製品は、ゲートウェイから要求を受信し、要求に基づいて指定されたクラウドリソースに対して操作を実行し、実行結果を返します。

7. APIゲートウェイは、クラウド製品から返されたデータを受信し、標準出力形式に変換し、データをビジネスサーバーに返します。

8. ビジネスサーバーは、APIゲートウェイから返されたデータを受信し、結果を処理して、ビジネスクライアントに返します。

条件

Endpoint

エンドポイントは、クライアントがクラウド製品にアクセスできるゲートウェイに登録されたサービスアドレスです。 エンドポイントは、サービスのアクセスプロトコル、ホスト名、ポート、およびパスを指定するURLです。 クライアントのユーザは、情報を利用してクラウドサービスと通信することができる。

ID、資格情報、および認証

Alibaba Cloud APIは、匿名APIと認証済みAPIの2種類に分類されます。 匿名APIを呼び出す場合は、リクエストがAPIのスタイルに準拠していることを確認するだけで済みます。 認証は必要ありません。

認証されたAPIを呼び出す場合、ゲートウェイは要求資格情報を検証して、呼び出し元のIDを確認する必要があります。 ゲートウェイは、IDが許可チェックに合格した後にのみ、要求をクラウドサービスに転送します。

呼び出し方法

Alibaba Cloudは、Alibaba Cloud SDK、Alibaba Cloud CLI、ROS (Resource Orchestration Service) など、開発者がAPI操作を呼び出すための複数の方法を提供しています。 HTTPリクエストを個別に実装することもできます。