Domain name for API request: mdc.tencentcloudapi.com.
This API is used to query the current status of a flow.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeStreamLinkFlowRealtimeStatus. |
Version | Yes | String | Common Params. The value used for this API: 2020-08-28. |
Region | No | String | Common Params. This parameter is not required for this API. |
FlowId | Yes | String | The flow ID. |
InputIds.N | No | Array of String | The IDs of the inputs to query. If this parameter and OutputIds are both empty, all inputs and outputs are queried. |
OutputIds.N | No | Array of String | The IDs of the outputs to query. If this parameter and OutputIds are both empty, all inputs and outputs are queried. |
Parameter Name | Type | Description |
---|---|---|
Timestamp | Integer | The timestamp (seconds) of the query. |
Datas | Array of FlowRealtimeStatusItem | A list of the real-time data. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: mdc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStreamLinkFlowRealtimeStatus
<Common request parameters>
{
"FlowId": "0176ac7f1af20956b92d2aad1e6d",
"InputIds": [
"0176ac7f1af30956b92d2aad1e6e"
],
"OutputIds": [
"0178c3f4bceb0956b92d149e1b5d"
]
}
{
"Response": {
"Timestamp": 1618543864,
"RequestId": "xx",
"Datas": [
{
"Protocol": "xx",
"ConnectServerIP": "xx",
"RTMPStatus": [
{}
],
"OutputId": "xx",
"FlowId": "xx",
"InputId": "xx",
"CommonStatus": {
"State": "xx",
"Reconnections": 0,
"Bitrate": 0,
"Mode": "xx",
"ConnectedTime": 0
},
"SRTStatus": [
{}
],
"Type": "xx",
"RTPStatus": {
"Packets": 0
}
},
{
"Protocol": "xx",
"ConnectServerIP": "xx",
"RTMPStatus": [
{}
],
"OutputId": "xx",
"FlowId": "xx",
"InputId": "xx",
"CommonStatus": {
"State": "xx",
"Reconnections": 0,
"Bitrate": 0,
"Mode": "xx",
"ConnectedTime": 0
},
"SRTStatus": [
{}
],
"Type": "xx",
"RTPStatus": {
"Packets": 0
}
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error. |
InvalidParameter.Id | Invalid ID. |
InvalidParameter.NotFound | No information found. |
Was this page helpful?