文档首页> API网关 APIG> API参考> 专享版API（V2）> 专享版-异步任务管理> 异步导入API
更新时间：2024-04-09 GMT+08:00
在线调试
CLI示例
查看PDF

异步导入API

功能介绍

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

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/async-import

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

is_create_group

否

Boolean

是否创建新分组

缺省值：true

group_id

否

String

API分组编号，当is_create_group=false时为必填

extend_mode

否

String

扩展信息导入模式

  • merge：当扩展信息定义冲突时，merge保留原有扩展信息
  • override：当扩展信息定义冲突时，override会覆盖原有扩展信息

缺省值：merge

枚举值：

  • merge
  • override

simple_mode

否

Boolean

是否开启简易导入模式

缺省值：false

mock_mode

否

Boolean

是否开启Mock后端

缺省值：false

api_mode

否

String

导入模式

  • merge：当API信息定义冲突时，merge保留原有API信息
  • override：当API信息定义冲突时，override会覆盖原有API信息

缺省值：merge

枚举值：

  • merge
  • override

file_name

是

File

导入Api的请求体，json或yaml格式的文件

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

task_id

String

任务id

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

导入API

{
  "is_create_group" : false,
  "group_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2",
  "file_name" : "APIGroup_test.json"
}

响应示例

状态码： 202

Accepted

{
  "task_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2"
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.3603",
  "error_msg" : "The input data is too long"
}

状态码： 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"
}

状态码： 500

Internal Server Error

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

状态码

状态码

描述

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。