# 配置管理接口

配置能力接口提供查询、查询所有、设置、及删除等操作,由品类服服务HTTP请求对应的能力接口。

# 查询配置

# 接口描述

获取指定Key的配置信息

# 接口定义
字段
URL /v1/infrastructure/config/:key
METHOD GET
HEADER category: 品类服唯一标别码,格式为:企业码-设备型号(Appliance Type)-型号码(Model Number),例如: 0000-B8-100VR501
# 参数说明
参数 类型 必须提供 说明
key String Yes 查询的缓存Key
# 返回内容
字段 类型 备注
key String 查询的Key
value String 查询结果,key对应的value

# 查询所有配置

# 接口描述

获取该品类服所有的配置信息

# 接口定义
字段
URL /v1/infrastructure/config/
METHOD GET
HEADER category: 品类服唯一标别码,格式为:企业码-设备型号(Appliance Type)-型号码(Model Number),例如: 0000-B8-100VR501
# 返回内容
字段 类型 备注
result 数组 返回结果的json数组
+key String 查询的Key
+value String 查询结果,key对应的value

返回结果样例:

[
  {
    "key": "String",
    "value": "String"
  },
  {
    "key": "String",
    "value": "String"
  },
  ......
]

# 设置配置

设置指定Key的配置信息

# 接口定义
字段
URL /v1/infrastructure/config/:key
METHOD PUT
HEADER category: 品类服唯一标别码,格式为:企业码-设备型号(Appliance Type)-型号码(Model Number),例如: 0000-B8-100VR501
# 参数说明
参数 类型 必须提供 说明
key String Yes 需要设置配置值的Key
value String Yes 要设置Key对应的配置值
# 返回内容
字段 类型 备注
result Boolean 执行结果,true-成功,false-失败

# 删除配置

删除指定Key的配置信息

# 接口定义
字段
URL /v1/infrastructure/config/:key
METHOD DELETE
HEADER category: 品类服唯一标别码,格式为:企业码-设备型号(Appliance Type)-型号码(Model Number),例如: 0000-B8-100VR501
# 参数说明
参数 类型 必须提供 说明
key String Yes 需要设置缓存值的Key
value String Yes 要设置Key对应的缓存Value
# 返回内容
字段 类型 备注
result Boolean 执行结果,true-成功,false-失败
最后修改于: 2021-06-23