更新时间:2024-02-28 GMT+08:00

导入kie配置

功能介绍

导入kie配置

URI

POST /v1/{project_id}/kie/file

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户子项目的唯一标识。字符长度为1~64。

表2 Query参数

参数

是否必选

参数类型

描述

override

String

覆盖策略,force 强制覆盖、abort 遇到第一个重复时终止导入后续的kv、skip 跳过重复的key

缺省值:force

枚举值:

  • force

  • abort

  • skip

label

String

指定label导入,格式为:{标签key}:{标签value},如果不填则按body的label导入

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

X-Enterprise-Project-ID

String

如果不带则默认企业项目为"default",ID为"0"

缺省值:0

Content-Type

String

该字段内容填为 "application/json;charset=UTF-8"

Accept

String

该字段内容填为 "application/json"

表4 FormData参数

参数

是否必选

参数类型

描述

upload_file

File

导入文件内容的格式必须为键值对映射,例如:{"data":[{"key1":"value1","key2":"value2"}]}}

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

success

Array of GetKieConfigs objects

导入成功的配置项列表。

failure

Array of failure objects

导入失败的配置项及其错误列表。

表6 GetKieConfigs

参数

参数类型

描述

id

String

配置项的id。

key

String

配置项的key。

labels

Object

配置项的标签。

value

String

配置项的值。

value_type

String

配置项value的类型。

status

String

配置项的状态。

create_time

Integer

创建时间。

update_time

Integer

更新时间。

create_revision

Long

创建配置的版本号

update_revision

Long

修改配置的版本号

表7 failure

参数

参数类型

描述

key

String

导入失败配置的key

labels

Object

导入失败配置的label

error_code

String

导入失败的错误码

error_message

String

导入失败的原因

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

detail

String

详细定位信息。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

detail

String

详细定位信息。

请求示例

POST https://{endpoint}/v3/{project_id}/kie/file

{ }

响应示例

状态码: 200

success

{
  "success" : [ {
    "id" : "8a9e6a5d-8d65-48fb-a40c-5150c8479da8",
    "key" : "string",
    "labels" : {
      "key" : "value"
    },
    "value" : "string",
    "value_type" : "text",
    "status" : "enabled",
    "create_time" : 1623139038,
    "update_time" : 1623139038,
    "create_revision" : 13,
    "update_revision" : 13
  } ],
  "failure" : [ {
    "key" : "string",
    "labels" : {
      "key" : "value"
    },
    "error_code" : "SVCSTG.004xxxxx",
    "error_message" : "Invalid parameters"
  } ]
}

状态码

状态码

描述

200

success

400

错误的请求。

500

服务器内部错误。

错误码

请参见错误码