すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud SDK:APIメタデータ

    ドキュメントセンター

    Alibaba Cloud SDK:APIメタデータ

    最終更新日:Jan 15, 2025

    Alibaba Cloudは、プログラミングによってクラウド リソースにアクセスし、管理できる幅広いAPI操作を提供しています。これらのAPI操作、特に自己署名モードで使用する場合は、APIメタデータを正しく理解して使用することが重要です。このトピックでは、自己署名モードでAPI操作を呼び出すために必要な情報を取得する方法について説明します。

    メタデータの概要

    APIメタデータは、Alibaba Cloud API操作に関連するすべての記述情報の集合です。自己署名モードでAPI操作を呼び出す前に、特定のクラウド サービスとAPI操作に関する次の情報を取得する必要があります。APIスタイル、プロトコル、リクエスト メソッド、パラメーター名、パラメーター タイプ、およびパラメーターの場所。

    サービスとバージョンの情報

    情報には、APIスタイル、サービス コード、およびAPIバージョンが含まれます。

    例：

    {"style":"RPC","product":"Ecs","version":"2014-05-26"}

    API概要

    Map構造を使用して、API操作名をキーとして、API概要を値として表示します。API概要には、次のパラメーターが含まれています。

    パラメーター

    説明

    例

    methods

    API操作でサポートされているリクエスト メソッド。

    ["post","get"]

    この例は、API操作がPOSTとGETの両方のリクエスト メソッドをサポートしていることを示しています。2つのメソッドの呼び出し結果に違いはありません。

    schemes

    API操作でサポートされているプロトコル。

    ["http","https" ]

    この例は、API操作がHTTPとHTTPSの両方をサポートしていることを示しています。

    parameters

    リクエスト パラメーター。

    {
    "name": "RegionId",
    "in": "query",
    "schema": {
        "description": "The region of the instance. You can call the DescribeRegions operation to query the most recent region list.
        "type": "string",
        "required": true,
        "example": "cn-hangzhou"
    }
}

    パラメーター情報には、パラメーター名、場所（query、path、およびbody）、パラメーター タイプ、およびパラメーターが必要かどうかが含まれます。

    エンドポイント

    クラウド サービスのエンドポイント。

    APIメタデータを取得する

    方法 1：クラウド サービスのメタデータを取得する

    OpenAPI ポータル にアクセスし、クラウド サービスを選択します。この例では、Elastic Compute Service が選択されています。[elastic Compute Service] の下の [メタデータ] をクリックします。

    image

    方法 2：API操作のメタデータを取得する

    OpenAPI ポータル にアクセスし、クラウド サービスを選択します。この例では、Elastic Compute Service が選択されています。呼び出す API 操作を選択し、ページの右上隅にある [メタデータ] をクリックします。

    image

    方法 3：メタデータ API 操作を呼び出してメタデータを取得する

    認証なしでインターネット経由でメタデータ API 操作を呼び出すことができます。次の表に、メタデータを取得する方法を示します。メタデータ API 操作の詳細については、使用ガイドライン を参照してください。

    操作

    API URL

    リクエスト メソッド

    すべてのクラウド サービスのサービス コードと API バージョンをクエリする

    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