API メタデータ (API スタイル、対応プロトコル、パラメーター定義など) は、Alibaba Cloud API リクエストの自己署名に必要です。ここでは、このメタデータの読み取り方法と取得方法について説明します。
クラウド製品の メタデータ概要
OpenAPI メタデータは、クラウド製品の API に関する記述情報です。署名プロセス中に、このメタデータから API スタイル、対応プロトコル、リクエストメソッド、パラメーター名、型、および場所を抽出します。
製品とバージョンの概要 (Info)
API スタイル、製品コード、バージョンが含まれます。
例:
{"style":"RPC","product":"Ecs","version":"2014-05-26"}
API 概要コレクション (apis)
API 名をキーとするマップであり、各値は次のパラメーターを持つ API 概要です:
|
パラメーター名 |
説明 |
例 |
|
methods |
対応しているリクエストメソッドです。 |
POST と GET の両方で同じ結果が返されます。 |
|
schemes |
対応プロトコルです。 |
HTTP と HTTPS の両方がサポートされています。 |
|
parameters |
リクエストパラメーターです。 |
各パラメーターの名前、場所 (クエリ、パス、またはボディ)、型、および必須かどうかを示します。 |
エンドポイントコレクション (endpoints)
クラウド製品のサービスエンドポイント。
メタデータの取得方法
方法1:クラウド製品のメタデータを取得
または API ドキュメント ページで、[Elastic Compute Service (ECS)] などのクラウド製品を選択し、製品名の下にある [メタデータの取得] をクリックします。
方法2:特定の API のメタデータを取得
またはAPI ドキュメントページで、ECS などのクラウド製品を選択し、対象の API を選択して、右上隅の[メタデータを取得]をクリックします。
方法3:メタデータ API の呼び出し
メタデータ API は、認証なしでパブリックにアクセスできます。メタデータを取得するには、次のエンドポイントを使用します。完全な API リファレンスについては、「」または「メタデータ使用ガイド」をご参照ください。
|
API の説明 |
API URL |
リクエストメソッド |
|
すべてのクラウド製品コードとバージョンの一覧表示 |
https://api.aliyun.com/meta/v1/products.json?language=EN_US |
GET |
|
特定の製品とバージョンのメタデータ取得 |
https://api.aliyun.com/meta/v1/products/{product}/versions/{version}/api-docs.json |
GET |
|
特定の API のメタデータ取得 |
https://api.aliyun.com/meta/v1/products/{product}/versions/{version}/apis/{api_name}/api.json |
GET |