查询健康状态

接口描述

1、通过健康检查来判断后端服务的可用性
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/group/health-check

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、集团账号接口计算签名请使用集团主账号的appId、appSecret

请求参数描述

示例

http://api.polyv.net/live/v4/group/health-check?appId=ga1ayl6dh2&timestamp=1661443126000&sign=9AEBDA585085BE8F6299F7DBB443F5D4

响应参数描述

Error参数描述

Data参数描述

Java请求示例

private static final Logger log = LoggerFactory.getLogger(GroupTestLive.class);
/**
 * 查询健康状态
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void healthCheckTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.groupAppId;
    String appSecret = super.groupAppSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/group/health-check";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询健康状态成功：{}", response);
    //do somethings
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "c7e83b9751fa4bfe9f57ba45494c147a.57.16529371726540445",
    "data": {
        "health": 1.61
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}