1. 功能说明
用于获取指定服务的配置信息,包括地址、端口、运行时间等信息
2. 协议设计原则
- 简化原则,目前统一使用POST方法
- 采用json文本协议,保证协议可读性高和扩展性
- 不添加额外的HTTP头部信息,只使用标准HTTP头部信息
- 所有的参数都在http的body部分
- json内容主要分header和body两部分,最上层为具体服务的缩写,本服务为
CMS
- 所有的字段类型为
string
3. 调用地址
POST https://cms.wonlycloud.com:10100
4. 消息类型定义
定义 | 描述 |
---|---|
MSG_GET_SERVICE_CONFIG_REQ | 请求获取服务配置 |
MSG_GET_SERVICE_CONFIG_RSP | 应答获取服务配置 |
5. 协议详解
每条协议都包含请求应答示例、请求参数说明、应答参数说明三个部分
5.1 获取服务配置
- 请求应答示例
MSG_GET_SERVICE_CONFIG_REQ
{
"CMS": {
"header": {
"api_version": "1.0",
"message_type": "MSG_GET_SERVICE_CONFIG_REQ",
"seq_id": "1"
},
"body": {
"username": "18888888888",
"secret_key": "xxxxxxxx",
"vendor_name": "general",
"uuid": "xxxxxxxxx",
"service_type": "DAS"
}
}
}
MSG_GET_SERVICE_CONFIG_RSP
{
"CMS": {
"header": {
"api_version": "1.0",
"message_type": "MSG_GET_SERVICE_CONFIG_RSP",
"seq_id": "1",
"http_code": "200",
"return_string": "RETURN_SUCCESS_OK_STRING"
},
"body": {
"server_ip": "xxx.xxx.xxx.xxx",
"server_port": "10600",
"server_area": "Asia:China:HangZhou",
"vendor_name": "general",
"run_seconds": "78979",
"status": "33344",
"active_index": "ActiveIndex",
"ret_ok": "1123534",
"ret_error": "2342"
}
}
}
-
请求参数说明
header
见HTTP API 公共包头body
主要是具体协议的内容,见下表
参数 | 选项 | 说明 | 备注 |
---|---|---|---|
username | 可选 | 用户名 | 必须为11位手机号,当用户请求时为必填 |
secret_key | 必填 | 授权令牌 | 设备访问其他服务所需的令牌 |
vendor_name | 必填 | 设备供应商名 | 参考公共参数 |
uuid | 可选 | 设备序列号 | 设备的唯一识别码,当设备请求时为必填 |
service_type | 必填 | 服务类型 | 需要获取配置的服务器类型,参考公共参数 |
-
应答参数说明
header
见HTTP API 公共包头body
主要是具体协议的内容,见下表
参数 | 说明 | 备注 |
---|---|---|
server_ip | 服务器地址 | 服务器外网地址 |
server_port | 服务器端口 | 服务器外网端口 |
server_area | 服务器区域 | 服务器所处的区域 |
vendor_name | 服务器厂商名 | 参考公共参数 |
run_seconds | 服务器运行时间 | 服务器的运行时间 |
status | 服务器当前连接数 | 服务器当前的连接数 |
active_index | 服务器每个命令的处理时间 | 服务器每个命令的处理时间 |
ret_ok | 服务器返回正确次数 | 服务器返回的正确次数 |
ret_error | 服务器返回错误次数 | 服务器返回的错误次数 |