Get Account MR Concurrency Details

Updated: 2022-09-02 18:08:07

API Description

1、获取账号MR并发详情信息
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/user/mr/concurrency-detail/get

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
The account must have MR live streaming cloud mode permission enabled.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See Signature Generation Rules

Example

https://api.polyv.net/live/v4/user/mr/concurrency-detail/get?appId=frlr1zazn3&timestamp=1660617675000&sign=581F7F16D89329DEC02BD73CCDE43CDB

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by the business. Returns `success` on success, `error` on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only for debugging and troubleshooting, should not be tied to business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	See data field description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error reason
desc	String	Error description, corresponding to error.code

data Parameter Description

Parameter	Type	Description
mrLiveConcurrency	Integer	Total concurrency
usedCount	Integer	Currently used concurrency
residualConcurrency	Integer	Remaining concurrency
channelIds	Array	List of channel IDs currently occupying concurrency, returns only the first 100

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(MrTest.class);
/**
 * 获取账号MR并发详情信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getMrConcurrencyTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/user/mr/concurrency-detail/get";

    //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("测试获取账号MR并发详情信息成功：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "4f5f3d1d-f746-4f9a-a98d-653198c084f1",
    "data": {
        "mrLiveConcurrency": 1,
        "usedCount": 1,
        "residualConcurrency": 0,
        "channelIds": [
            "3265597"
        ]
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API