更新时间:2024-07-31 GMT+08:00
分享

API导入资源包文件

功能介绍

API导入资源包文件。

URI

POST /v1/{project_id}/resource-package/api-import

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

工作空间ID。

X-Auth-Token

String

用户Token。

Content-Type

String

固定值,指定请求体类型和字符集。

表3 FormData参数

参数

是否必选

参数类型

描述

file

File

资源包文件。

import_strategy

String

导入策略,replace|addNew。

replace_rule

String

替换规则,默认值为BY_ID,取值范围:BY_ID、BY_NAME

最小长度:0

最大长度:100

枚举值:

  • BY_ID
  • BY_NAME

响应参数

表4 响应Body参数

参数

参数类型

描述

task_id

String

任务ID。

请求示例

API导入资源包文件。

POST https://{endpoint}/v1/{project_id}/resource-package/api-import
{
    "file": 文件流,
    "import_strategy": "replace",
    "replace_rule": "BY_ID"
}

响应示例

导入资源包成功。

{
  "task_id" : "b8913c92-xxxx-4721-b8fd-a72af3945b61"
}

状态码

表5

状态码

描述

200

导入资源包成功。

错误码

请参见错误码

相关文档