GetApiDefinition

更新时间:
复制 MD 格式

Queries the metadata for an API operation of a cloud service.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /api/definition HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

product

string

Yes

The product code. You can find it in two ways:

  • Call the GetRequestLog operation. The product code will be included in the response data.

  • The product code is the last part of the service's URL in OpenAPI Explorer. For example, the OpenAPI Explorer URL for Short Message Service is https://api.aliyun.com/product/Dysmsapi. Therefore, the product code is Dysmsapi.

Ecs

apiVersion

string

Yes

The API version.

2014-05-26

api

string

Yes

The API name.

DescribeRegions

Response elements

Element

Type

Description

Example

object

The metadata of the API.

Examples

Success response

JSON format

{}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.