全部產品
Search

搜尋本產品

    Alibaba Cloud SDK：OpenAPI中繼資料

    文件中心

    Alibaba Cloud SDK：OpenAPI中繼資料

    更新時間：Nov 19, 2024

    阿里雲提供了豐富的API介面，支援使用者通過編程方式訪問和管理雲資源。在使用這些API時，特別是在自簽名情境下，正確理解和運用API的中繼資料對於實現自簽名機制至關重要。本文將為您介紹在自簽名情境中，如何快速擷取自簽名所需的資訊。

    雲產品中繼資料介紹

    雲產品的OpenAPI中繼資料是指與API相關的所有描述性資訊的集合。在進行簽名操作時，您需要從以下參數中擷取雲產品的API風格，以及API所支援的協議、要求方法、參數名稱、參數類型及參數位置等相關資訊。

    產品及版本的概述資訊（Info）

    包括產品的API風格、產品Code及其版本。

    樣本：

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

    API概要資訊集合（apis）

    採用Map結構，其中Key為API名稱，值為相應的API概要資訊。API概要資訊中包含以下參數資訊：

    參數名稱

    參數描述

    樣本

    methods

    支援的要求方法集合。

    ["post","get"]

    表示API同時支援POST和GET請求方式，但兩者在調用結果上無任何差異。

    schemes

    支援的協議集合。

    ["http","https" ]

    表示API同時支援HTTP協議和HTTPS協議。

    parameters

    請求參數集合。

    {
    "name": "RegionId",
    "in": "query",
    "schema": {
        "description": "執行個體所屬的地區ID。您可以調用[DescribeRegions](~~25609~~)查看最新的阿里雲地區列表。",
        "type": "string",
        "required": true,
        "example": "cn-hangzhou"
    }
}

    具體描述了參數名稱、參數位置（query、path、body）、參數類型以及是否為必傳等資訊。

    服務存取點集合（endpoints）

    雲產品支援服務地址。

    中繼資料擷取方式

    方式一：擷取雲產品中繼資料。

    訪問API文檔，選擇對應的雲產品，本文以Elastic Compute Service為例。單擊Elastic Compute Service名稱下方的擷取中繼資料。

    image

    方式二：擷取某個API的中繼資料。

    訪問API文檔，選擇對應的雲產品，本文以Elastic Compute Service為例。選擇將要調用的API，單擊頁面右上方擷取中繼資料。

    image

    方式三：調用中繼資料API擷取中繼資料。

    中繼資料API無需進行鑒權，可在公網環境中自由調用。您可以參考下表內容以擷取中繼資料，有關中繼資料API的詳細資料，請參見中繼資料使用指南。

    API描述

    API URL

    請求方式

    查詢所有雲產品CODE及VERSION

    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