查詢健康狀態

更新時間：2022-09-02 18:08:07

介面描述

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

介面URL

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

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS以確保介面安全，介面呼叫有頻率限制，詳細請查看

2、集團帳號介面計算簽名請使用集團主帳號的appId、appSecret

請求參數描述

參數名	必選	類型	說明
appId	true	String	集團主帳號appId
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】

範例

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

回應參數描述

參數名	類型	說明
code	Integer	狀態碼，與http狀態碼相同，用於確定基本的回應狀態
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應
requestId	String	請求ID，每次請求產生的唯一UUID，僅可用於排查、除錯，不應該和業務掛鉤
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位描述】
data	Object	【詳見data欄位說明】

Error參數描述

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與error.code對應

Data參數描述

參數名	類型	說明
health	Float	健康狀態，保留兩位小數，分值範圍0~100 (0,30] ：低負載 (30,60] ：中負載 (60,90] ：高負載 (90,100] ：危險

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
}