文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 历史API/ 查询配置
更新时间：2024-09-25 GMT+08:00
查看PDF
分享

查询配置

功能介绍

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

调用方法

  • 微服务引擎专业版，请参考如何调用API。
  • 微服务引擎专享版，请参考如下方法调用：
    1. 登录ServiceStage控制台，选择“微服务引擎 > 引擎实例”。
    2. 选择“微服务引擎”下拉列表中待调用接口的微服务引擎。
    3. 在“服务发现 & 配置”区域，查看或单击复制“配置中心地址”。
    4. 参考如何调用API访问该接口，在请求URI中，替换{Endpoint}为已获取到的配置中心地址。

URI

GET /v3/{project_id}/configuration/items

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String
表2 Query参数

参数

是否必选

参数类型

描述

dimensionsInfo

是

String

服务信息，为服务名、应用、版本的拼接（服务名、应用必填，版本选填），拼接格式为（请注意“@”和“#”添加到http url时需转义，“@”转义为“%40”，“#”转义为“%23”）：

{serviceName}@{appId}#{version} 或{serviceName}@{appId}

不能包含$%^&+/\特殊字符和空格。

keyFilter

否

String

key的筛选条件， 支持正则表达式。涉及特殊字符的正则表达式需要自行转义。

revision

否

String

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

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

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

x-environment

否

String

指定查询配置的environment，取值包括：development、testing、acceptance、production。其他值均被作为空值处理。

Authorization

是

String

若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。

开启了安全认证的微服务引擎专享版Token，格式为：

Authorization:Bearer {Token}

Token获取方法，请参考获取微服务引擎专享版用户Token。

响应消息

若传入的revision值与当前配置的revision一致，则无响应消息。

响应参数说明请参见表4。

表4 响应参数

参数

参数类型

描述

{dimension}（参数名称和参数个数不固定）

Map<String, String>

配置内容

revision

表5

revision
表5 revision

参数

参数类型

描述

version

String

配置版本

请求示例

GET /v3/default/configuration/items?dimensionsInfo=service%40app%231.0.0

响应示例

{
    "service@app": {
        "k1": "v1"
    },
    "service@app#1.0.0": {
        "k2": "v2"
    }
}

状态码

状态码请参见状态码。

错误码

错误码请参见CSE错误码。

父主题： 历史API