导出kie配置 - ExportKieConfigurations

功能介绍

导出kie配置。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
cse:config:download	write	-	g:EnterpriseProjectId	cse:config:modify	-

URI

POST /v1/{project_id}/kie/download

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户子项目的唯一标识。字符长度为1~64。

表2 Query参数
参数	是否必选	参数类型	描述
label	否	String	按label过滤项导出，格式为：{标签key}:{标签value}。
match	否	String	对label过滤项的匹配选项。如果值为exact，表示严格匹配，包括label个数和内容相等；不填表示包含匹配。枚举值： exact

请求参数

表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"。
x_engine_id	是	String	微服务引擎专享版ID。

表4 请求Body参数
参数	是否必选	参数类型	描述
ids	是	Array of strings	配置ID的集合。

响应参数

状态码： 200

表5 响应Body参数
参数	参数类型	描述
metadata	metadata object	导出文件的描述信息。
data	Array of CreateKieReq objects	导出的配置项列表。

表6 metadata
参数	参数类型	描述
version	String	导出数据的版本号。
annotations	Object	导出文件的其他信息。

表7 CreateKieReq
参数	参数类型	描述
id	String	配置项的id。
key	String	配置项的key。缺省值：$random(6)-$date(yyyy-MM-dd-HH-mm-ss)
labels	Object	配置项的标签。
value	String	配置项的值。缺省值：$random(20)
value_type	String	配置项value的类型。枚举值： text yaml json properties ini xml 缺省值：text
status	String	配置项的状态。枚举值： disabled enabled 缺省值：enabled

状态码： 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/download}/jobs/{job_id}

{
  "ids" : [ "8a9e6a5d-8d65-48fb-a40c-5150c8479da8", "8a9e6a5d-8d65-48fb-a40c-5150c8479da8" ]
}

响应示例

状态码： 200

导出的文件内容，文件名会根据environment标签的值命名，如：label=environment:development，则文件名为development+时间戳.json，如：label=environment:，则文件名为default+时间戳.json，如不包含或包含多个environment，会以custom+时间戳.json命名。

{
  "metadata" : {
    "version" : "1.0.0",
    "annotations" : { }
  },
  "data" : [ {
    "id" : "46f9ae5f0d36c438d5d70392b42a2a1072879e8f7e373af4c021d1155bb5c4ac",
    "key" : "$random(6)-$date(yyyy-MM-dd-HH-mm-ss)",
    "labels" : {
      "key" : "value"
    },
    "value" : "$random(20)",
    "value_type" : "text",
    "status" : "enabled"
  } ]
}

状态码

状态码	描述
200	导出的文件内容，文件名会根据environment标签的值命名，如：label=environment:development，则文件名为development+时间戳.json，如：label=environment:，则文件名为default+时间戳.json，如不包含或包含多个environment，会以custom+时间戳.json命名。
400	错误的请求。
500	服务器内部错误。