ExportOAS - 导出OAS定义

更新时间:
复制为 MD 格式

导出OAS。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:ExportOAS

get

*ApiGroup

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

请求参数

名称

类型

必填

描述

示例值

DataFormat

string

Swagger 文本格式:

  • json

  • yaml

yaml

ApiIdList

array

需要导出的 API 列表

string

API ID

8afff6c8c4c6447abb035812e4d66xxx

GroupId

string

API 分组 ID

42925e7f5209438186d5560239af5xxx

StageName

string

API 已发布的环境:

  • RELEASE:线上

  • PRE:预发

  • TEST:测试

RELEASE

OasVersion

string

OAS 版本号:

  • oas2

  • oas3

oas2

WithXExtensions

boolean

是否导出 API 网关拓展定义

true

PageNumber

integer

导出分组下所有 API 时的分页页码

1

返回参数

名称

类型

描述

示例值

object

Data

string

Swagger 文件经 base64 编码后的数据,通过 base64 解码可以得到文件

UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...

RequestId

string

请求 ID

CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情