OpenAPI metadata

Cloud product metadata overview

OpenAPI metadata is the set of descriptive information for a cloud product's APIs. During signing, extract the API style, supported protocols, request methods, parameter names, types, and locations from this metadata.

Product and version overview (Info)

Includes the API style, product code, and version.

Example:

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

API summary collection (apis)

A Map keyed by API name, where each value is an API summary with the following parameters:

["post","get"]

["http","https" ]

{
    "name": "RegionId",
    "in": "query",
    "schema": {
        "description": "The region ID of the instance. You can call [DescribeRegions](~~25609~~) to view the latest list of Alibaba Cloud regions.",
        "type": "string",
        "required": true,
        "example": "cn-hangzhou"
    }
}

Endpoint collection (endpoints)

Service endpoints for the cloud product.

How to obtain metadata

Method 1: Get cloud product metadata

On the or API documentation page, select a cloud product such as Elastic Compute Service (ECS), and click Get Metadata below the product name.

Method 2: Get metadata for a specific API

On the or API documentation page, select a cloud product such as ECS, choose the target API, and click Get Metadata in the upper-right corner.

Method 3: Call the metadata API

The metadata API is publicly accessible without authentication. Use the following endpoints to retrieve metadata. The complete API reference is in the or Metadata usage guide.