文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 服务集成API/ OpenAPI接口/ 导入API - ImportApiDefinitionsV2
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

导入API - ImportApiDefinitionsV2

功能介绍

导入API。导入文件内容需要符合swagger标准规范，自定义扩展字段请参考用户指南的“附录：前端API的Swagger扩展定义”章节。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v2/{project_id}/apic/instances/{instance_id}/openapi/import

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

is_create_group

否

Boolean

是否创建新分组

group_id

否

String

API分组编号。

当is_create_group=false时为必填

app_id

否

String

应用编号。

当is_create_group=false且使用集成应用分组时必填

extend_mode

否

String

扩展信息导入模式

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

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

simple_mode

否

Boolean

是否开启简易导入模式

mock_mode

否

Boolean

是否开启Mock后端

api_mode

否

String

导入模式

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

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

file_name

是

File

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

success

Array of Success objects

导入成功信息

failure

Array of Failure objects

导入失败信息

swagger

Swagger object

swagger文档导入结果

暂不支持

group_id

String

API分组编号

ignore

Array of Ignore objects

被忽略导入的API信息
表5 Success

参数

参数类型

描述

path

String

API请求路径

method

String

API请求方法

action

String

导入行为：

  • update：表示更新API

  • create：表示新建API

id

String

导入成功的API编号
表6 Failure

参数

参数类型

描述

path

String

API请求路径

error_msg

String

导入失败的错误信息

method

String

API请求方法

error_code

String

导入失败的错误码
表7 Swagger

参数

参数类型

描述

id

String

swagger文档编号

result

String

导入结果说明
表8 Ignore

参数

参数类型

描述

method

String

API请求方法

path

String

API请求路径

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：404

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

导入API。表单字段file_name为文件类型

{
  "file_name" : "APIGroup_test.yaml"
}

响应示例

状态码：200

OK

{
  "group_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2",
  "failure" : [ {
    "path" : "/test/demo",
    "error_msg" : "The API already exists, An API with the same combination of the method, path, and x-apigateway-match-mode fields already exists. API name: API_demo",
    "method" : "GET",
    "error_code" : "APIG.3301"
  } ],
  "success" : [ {
    "path" : "/test",
    "method" : "GET",
    "action" : "create",
    "id" : "8ae6bcafab6f49d78242bff26ad8a4f0"
  } ],
  "swagger" : {
    "id" : "412488ba965041f9838a5266a5f8e574",
    "result" : "Success"
  }
}

状态码：400

Bad Request

{
  "error_code" : "APIG.3201",
  "error_msg" : "The API group name already exists"
}

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

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

错误码

请参见错误码。

父主题： OpenAPI接口