更新时间:2024-01-29 GMT+08:00

查询配置列表

功能介绍

从配置管理中心查询配置列表信息。

URI

GET /v1/{project_id}/kie/kv

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

请填固定值:default。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

若ServiceComb引擎专享版开启了安全认证,此参数必填。否则,无此参数。

开启了安全认证的ServiceComb引擎专享版Token,格式为:

Authorization:Bearer {Token}

Token获取方法,请参考获取ServiceComb引擎专享版用户Token

表3 Query参数

参数

是否必选

参数类型

描述

label

String

按label过滤项导出,格式为:{标签key}:{标签value}。

match

String

对label过滤项的匹配选项,如果值为exact,表示严格匹配,包括label个数和内容相等;不填表示包含匹配。

revision

Integer

配置的版本号。

用于判断本地缓存配置和配置管理中心的配置差异。

  • 首次传值0。
  • 若传入的revision值与当前配置的revision一致,则返回304状态码,无body体返回;若不一致,则返回当前配置和revision信息。
  • 下次请求若需要传入revision,则该值为当前返回body体中的update_revision 。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

查询结果个数。

data

List<SingleKieInfo>

查询的kie列表。

表5 SingleKieInfo

参数

参数类型

描述

id

String

配置id。

key

String

配置的key。

value

String

配置的value。

value_type

String

配置value的类型。

status

String

配置的状态。

create_time

String

配置的创建时间。

update_time

String

配置的更新时间。

labels

Map<String,String>

配置的标签信息。

create_revision

Integer

配置的创建版本号。

update_revision

Integer

配置的修改版本号。

状态码:304

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误代码。

error_message

String

错误信息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误代码。

error_message

String

错误信息。

请求示例

查询配置列表。

GET https://{endpoint}/v1/{project_id}/kie/kv

响应示例

状态码: 200

查询成功。
{   
    "total": 1,   
    "data":[{   
        "id": "8a9e6a5d-8d65-48fb-a40c-5150c8479da8",   
        "key": "string",   
        "labels": {     
            "key1": "value1",
            "key2": "value2"
        },   
        "value": "string",   
        "value_type": "text",   
        "status": "enabled",   
        "create_time": 1623139038,   
        "update_time": 1623139038,
        "create_revision": 13,
        "update_revision": 13
    }]
}

状态码

状态码

描述

200

查询成功。

304

查询的配置未改变。

400

错误的请求。

500

服务内部错误。

错误码

请参见错误码