导出配置 - ExportConfigurations

功能介绍

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

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

调试

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

授权信息

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

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

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

URI

POST /v1/{project_id}/kie/download

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

表2 Query参数
参数	是否必选	参数类型	描述
label	否	String	按label过滤项导出，格式为：{标签key}:{标签value}。
match	否	String	对label过滤项的匹配选项。如果值为exact表示严格匹配，包括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参数
参数	是否必选	参数类型	描述
ids	是	List<String>	待导出的配置项的id列表，获取方法请参考查询配置列表 - QueryConfigurationList。当ids取空列表时，调用该接口表示导出所有配置项。

响应参数

状态码： 200

表5 响应Body参数
参数	是否必选	参数类型	描述
metadata	否	Object	配置项的额外信息。
data	是	List<KVCreateBody>	待创建的配置项列表。

表6 KVCreateBody
参数	是否必选	参数类型	描述
id	是	String	配置的ID。
key	是	String	配置的key。
value	否	String	配置的value。
labels	否	Map<String,String>	配置的labels。
status	否	String	配置的状态。取值范围： disabled：配置不可用 enabled：配置可用
value_type	否	String	配置value的类型。取值范围： text yaml json properties ini xml

表7 Metadata
参数	是否必选	参数类型	描述
version	否	String	版本信息。
annotations	否	Object	配置项的额外信息。

状态码： 400

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

状态码： 500

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

请求示例

导出配置ID为“0bdfddb8-c4f9-4a88-8360-07a8a616a804”的配置信息。

POST https://{endpoint}/v1/{project_id}/kie/download

{
    "ids":[
        "0bdfddb8-c4f9-4a88-8360-07a8a616a804"
    ]
}

响应示例

查询成功

{
    "metadata": {
        "version": "2.0.0"
    },
    "data": [
        {
            "id": "0bdfddb8-c4f9-4a88-8360-07a8a616a804",
            "key": "2",
            "labels": {
                "2": "2"
            },
            "value": "2",
            "status": "enabled",
            "value_type": "text"
        },
        {
            "id": "34befef9-7f3a-4394-85f9-142622a11b1d",
            "key": "1",

            "labels": {
                "1": "1"
            },
            "value": "1",
            "status": "enabled",
            "value_type": "text"
        }
    ]
}