文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-OpenAPI接口/ 导出API
更新时间：2024-11-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

导出API

功能介绍

导出分组下API的定义信息。导出文件内容符合swagger标准规范，API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API：扩展定义”章节。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。
表2 Query参数

参数

是否必选

参数类型

描述

oas_version

否

String

OpenAPI版本

缺省值：2.0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表4 请求Body参数

参数

是否必选

参数类型

描述

env_id

是

String

API分组发布的环境ID

group_id

是

String

API分组ID

define

否

String

导出API的定义范围：

  • spec：基础定义，只包括api前端定义
  • proxy：全量定义，包括api前后端定义
  • all：扩展定义，包括api前后端定义以及流控、访问控制、自定义认证等扩展定义
  • dev：开发定义，包括未发布的api的前后端定义

缺省值：spec

type

否

String

导出的API定义的格式

缺省值：json

version

否

String

导出的API定义版本，默认为当前时间

apis

否

Array of strings

导出的API ID列表

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

-

File

-

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

批量导出API

{
  "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "define" : "all"
}

响应示例

状态码： 400

Bad Request

{
  "error_code" : "APIG.2001",
  "error_msg" : "The request parameters must be specified,parameterName:env_id. Please refer to the support documentation"
}

状态码： 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

Not Found

{
  "error_code" : "APIG.3001",
  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档