导入配置 - ImportConfigurations

功能介绍

从配置管理中心导入配置信息。

此接口适用于微服务引擎为2.x版本。
参考如何调用API调用该接口，在请求URI中，替换{Endpoint}为终端节点。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cse:config:upload
write
-
g:EnterpriseProjectId
cse:config:modify
-

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

URI

POST /v1/{project_id}/kie/file

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户子项目的唯一标识，字符长度为1~64位，获取方法请参考获取项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
override	是	String	覆盖策略。取值范围： force：强制导入，会覆盖重复项。 skip：跳过导入，会跳过重复项。 abort：终止导入，遇到重复项会停止导入操作。默认取值： force
label	否	String	指定label导入，格式为：{标签key}:{标签value}，如果不填则按body的label导入。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。
x-engine-id	是	String	待上传配置的引擎id，获取方法请参考查询微服务引擎列表 - QueryMicroserviceEngineList。
X-Enterprise-Project-ID	否	String	企业项目ID。如果不配置此参数，则默认企业项目为“default”，ID为0。

表4 请求Body参数
参数	是否必选	参数类型	描述
upload_file	是	File	导入的文件，文件名格式为：fileName.json 文件格式为： { "data": [ { "key": "keyItem1", "value": "valueItem1", "labels":{ "1": "1" }, "status": "enabled", "value_type": "text" } ] }

响应参数

状态码： 200

表5 响应Body参数
参数	参数类型	描述
success	List<KVDoc>	导入成功的配置项列表。
failure	List<DocFailedOfUpload>	导入失败的配置项列表。

表6 KVDoc
参数	参数类型	描述
id	String	配置ID。
key	String	配置的key。
value	String	配置的value。
value_type	String	配置value的类型。取值范围： text yaml json properties ini xml
status	String	配置的状态。取值范围： disabled：配置不可用 enabled：配置可用
create_time	Integer	配置的创建时间。
update_time	Integer	配置的更新时间。
create_revision	Integer	创建配置的版本号。
update_revision	Integer	修改配置的版本号。
labels	Map<String,String>	配置的标签信息。

表7 DocFailedOfUpload
参数	参数类型	描述
key	String	导入失败配置项的key。
labels	Map<String,String>	导入失败配置项的labels信息。
error_code	String	错误代码。
error_message	String	错误信息。

状态码： 400

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误代码。
error_message	String	错误信息。
detail	String	详细定位信息。

状态码： 500

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误代码。
error_message	String	错误信息。
detail	String	详细定位信息。

请求示例

导入配置文件，当存在相同配置时，会强制导入覆盖重复项，按body的label导入。

POST https://{endpoint}/v1/{project_id}/kie/file/override=force

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="upload_file"; filename="custom_1663124521493.json"
Content-Type: application/json
----WebKitFormBoundary7MA4YWxkTrZu0gW

响应示例

查询成功

{
    "success": [
        {
            "id": "7e2d346e-d907-4871-bf51-a17fc7e52ad4",
            "key": "2",
            "value": "2",
            "value_type": "text",
            "create_revision": 3,
            "update_revision": 3,
            "status": "enabled",
            "create_time": 1636374809,
            "update_time": 1636374809,
            "labels": {
                "2": "2",
                "environment": "production"
            }
        },
        {
            "id": "907b3891-c691-4ae0-816f-e91eba705e28",
            "key": "1",
            "value": "1",
            "value_type": "text",
            "create_revision": 4,
            "update_revision": 4,
            "status": "enabled",
            "create_time": 1636374809,
            "update_time": 1636374809,
            "labels": {
                "1": "1",
                "environment": "production"
            }
        }
    ],
    "failure": []
}