tencent cloud

All product documents
APIs
DocumentationAPIsStreamLinkFlow APIsDescribeStreamLinkFlows
DescribeStreamLinkFlows
Last updated: 2024-09-09 10:35:07
DescribeStreamLinkFlows
Last updated: 2024-09-09 10:35:07

1. API Description

Domain name for API request: mdc.tencentcloudapi.com.

This API is used to query the configuration information of multiple StreamLink flows in batches.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeStreamLinkFlows.
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.
PageNum No Integer Number of the current page. Default value: 1
PageSize No Integer Number of entries per page. Default value: 10

3. Output Parameters

Parameter Name Type Description
Infos Array of DescribeFlow List of the configuration information of the flows
PageNum Integer Number of the current page
PageSize Integer Number of entries per page
TotalNum Integer Total number of entries
TotalPage Integer Total number of pages
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.

4. Example

Example1 Sample request

Input Example

POST / HTTP/1.1
Host: mdc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStreamLinkFlows
<Common request parameters>

{
    "PageNum": 1,
    "PageSize": 10
}

Output Example

{
    "Response": {
        "TotalPage": 1,
        "PageNum": 1,
        "PageSize": 10,
        "RequestId": "aaaaa",
        "Infos": [
            {
                "FlowName": "sacdsad",
                "InputGroup": [
                    {
                        "AllowIpList": [
                            "0.0.0.0/0"
                        ],
                        "Protocol": "SRT",
                        "Description": "asda",
                        "RTPSettings": {
                            "IdleTimeout": 1000,
                            "FEC": "none"
                        },
                        "InputName": "123sadsasada2",
                        "SRTSettings": {
                            "Latency": 1000,
                            "PeerLatency": 1000,
                            "PbKeyLen": 1000,
                            "RecvLatency": 1000,
                            "Passphrase": "aaaa",
                            "StreamId": "1111",
                            "PeerIdleTimeout": 1000
                        },
                        "RTMPSettings": {
                            "StreamKey": "streamid?a=b",
                            "AppName": "live_appid"
                        },
                        "InputRegion": "ap-mumbai",
                        "InputId": "1213",
                        "InputAddressList": [
                            {
                                "Ip": "0.0.0.0",
                                "Port": 0
                            }
                        ]
                    }
                ],
                "FlowId": "123ds12",
                "State": "IDLE",
                "OutputGroup": [
                    {
                        "OutputName": "sad231edqsq",
                        "OutputAddressList": [
                            {
                                "Ip": "2.2.2.2"
                            }
                        ],
                        "Protocol": "RTP",
                        "Description": "aaaaasss",
                        "RTPSettings": {
                            "IdleTimeout": 1000,
                            "FEC": "none",
                            "Destinations": [
                                {
                                    "Ip": "3.3.3.3",
                                    "Port": 0
                                }
                            ]
                        },
                        "OutputType": "Internet",
                        "SRTSettings": {
                            "Latency": 10000,
                            "PeerLatency": 20000,
                            "PbKeyLen": 10000,
                            "RecvLatency": 30000,
                            "Passphrase": "aaaa",
                            "StreamId": "aaaa",
                            "PeerIdleTimeout": 40000,
                            "Destinations": [
                                {
                                    "Ip": "4.4.4.4",
                                    "Port": 0
                                }
                            ]
                        },
                        "OutputId": "asd21dsa",
                        "RTMPSettings": {
                            "IdleTimeout": 1000,
                            "ChunkSize": 4096,
                            "Destinations": [
                                {
                                    "Url": "rtmp://domain/live",
                                    "StreamKey": "streamid?a=b"
                                }
                            ]
                        },
                        "OutputRegion": "xx"
                    }
                ],
                "MaxBandwidth": 10000000
            }
        ],
        "TotalNum": 1
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.PageNum Invalid PageNum.
InvalidParameter.PageSize Invalid PageSize.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support