健康检查接口
场景描述
给第三方接入方调用,检查CC-CMS是否正常运行。
接口方法
设置成“POST”。该接口仅支持POST方法,不支持PUT、GET和DELETE等方法。
URL
https://ip:port/rest/cmsapp/v1/ping
其中,公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。
非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
Content-Type |
String |
True |
固定填 application/json; charset=UTF-8。 |
2 |
Authorization |
String |
True |
生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 |
参数名 |
数据类型 |
是否必选 |
说明 |
---|---|---|---|
say(可以修改) |
object |
True |
请求报文,代码中不会对这个报文做任何处理,会回写到响应消息体中。 |
响应说明
参数名 |
数据类型 |
说明 |
---|---|---|
status |
string |
响应成功返回“UP” |
request |
object |
响应成功返回入参对象 |
报文样例
- 请求头:
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- 请求参数:
{ "say": "Hello world!" }
- 响应参数:
{ "request": { "say": "Hello world!" }, "status": "UP" }