Export API Gateway APIs in OAS Format Using ExportOAS - API Gateway

Exports APIs based on OpenAPI Specification (OAS).

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:ExportOAS

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
DataFormat	string	No	The exported format: json yaml	yaml
ApiIdList	array	No	The APIs that you want to export.
	string	No	The API ID.	8afff6c8c4c6447abb035812e4d66xxx
GroupId	string	No	The API group ID.	42925e7f5209438186d5560239af5xxx
StageName	string	No	The environment to which the API is published. Valid values: RELEASE: the production environment PRE: the pre-release environment TEST: the test environment	RELEASE
OasVersion	string	No	The OAS version. Valid values: oas2 oas3	oas2
WithXExtensions	boolean	No	Specifies whether to export API Gateway extensions at the same time.	true
PageNumber	integer	No	The number of pages in which you want to export the APIs.	1

Response elements

Element	Type	Description	Example
	object
Data	string	The Base64-encoded data of the exported Swagger file. You can obtain the file by using Base64 decoding.	UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx

Examples

Success response

JSON format

{
  "Data": "UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.