导出OAS。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
apigateway:ExportOAS | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DataFormat | string | 否 | Swagger 文本格式:
| yaml |
ApiIdList | array | 否 | 需要导出的 API 列表 | |
string | 否 | API ID | 8afff6c8c4c6447abb035812e4d66xxx | |
GroupId | string | 否 | API 分组 ID | 42925e7f5209438186d5560239af5xxx |
StageName | string | 否 | API 已发布的环境:
| RELEASE |
OasVersion | string | 否 | OAS 版本号:
| oas2 |
WithXExtensions | boolean | 否 | 是否导出 API 网关拓展定义 | true |
PageNumber | integer | 否 | 导出分组下所有 API 时的分页页码 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"Data": "UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...",
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx"
}
错误码
访问错误中心查看更多错误码。