----
==== 查询接口 ====
查询接口用于查询系统目前配置项的取值,或者用于查询目前的系统状态,具体接口如下:\\
**请求地址:**
http://127.0.0.1:xxxx/apiQueryConfig?ConfName={ConfName}&SessionKey={SessionKey}
**请求方式:** GET\\
**参数说明:**
^ 参数 ^ 是否必须 ^ 说明 ^
| SessionKey | 是 | 通过认证接口获取的会话密钥,如果没有Bangwo8APIServer.conf或者Bangwo8APIServer.conf中ServerSecureKey为空,则表明访问无需秘钥保护,此时不需要此字段 |
| ConfName | 是 | URLEncode之后的配置项变量名或者需要查询的状态项名称,支持的配置项/状态项有:\\ * [[:帮我吧文档:客户端SDK手册:配置项列表|系统支持的配置项列表]]\\ * [[:帮我吧文档:客户端SDK手册:状态项列表|系统支持的状态项列表]] |
**返回值说明:**\\
正常情况下,本接口会返回下述JSON数据包给开发者:
{
"errorcode" : 0,
"message" : "success",
"data" : "success",
}
^ JSON字段 ^ 说明 ^
| errorcode | 应答结果码:\\ 0: 成功\\ 1: ConfName不能为空\\ 2: 提供的ConfValue非法\\ 3: 提供的SessionKey非法\\ 4: 不支持给定的ConfName |
| message | 出错消息,可以用于获取进一步的出错原因(该字段在所有应答消息中都有) |
| data | 查询的配置项或者状态项的取值 |