全部产品
Search

搜索本产品

    阿里云SDK：OpenAPI元数据

    文档中心

    阿里云SDK：OpenAPI元数据

    更新时间：Nov 18, 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文档，选择对应的云产品，本文以云服务器ECS为例。单击云服务器ECS名称下方的获取元数据。

    image

    方式二：获取某个API的元数据。

    访问API文档，选择对应的云产品，本文以云服务器ECS为例。选择将要调用的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