导出API - ExportApiDefinitionsV2
功能介绍
导出分组下API的定义信息，导出文件内容符合swagger标准规范。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/apic/instances/{instance_id}/openapi/export
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
instance_id | 是 | String | 实例ID |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
oas_version | 否 | String | OpenAPI版本。
默认值为2.0，默认导出为swagger2.0版本。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
env_id | 是 | String | API分组发布的环境ID |
group_id | 是 | String | API分组ID |
define | 否 | String | 导出API的定义范围：
|
type | 否 | String | 导出的API定义的格式
|
version | 否 | String | 导出的API定义版本，默认为当前时间 |
apis | 否 | Array of strings | 导出的API ID列表 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
- | File |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
请求示例
导出指定API分组下的API，API定义范围为all
{
"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 |
错误码
请参见错误码。
