1. API Description
Domain name for API request: mdl.tencentcloudapi.com.
This API is used to create a StreamLive input.
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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: CreateStreamLiveInput. |
| Version | Yes | String | Common parameter. The value used for this API: 2020-03-26. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| Name | Yes | String | Input name, which can contain 1-32 case-sensitive letters, digits, and underscores and must be unique at the region level |
| Type | Yes | String | Input type Valid values: RTMP_PUSH, RTP_PUSH, UDP_PUSH, RTMP_PULL, HLS_PULL, MP4_PULL |
| SecurityGroupIds.N | No | Array of String | ID of the input security group to attach You can attach only one security group to an input. |
| InputSettings.N | No | Array of InputSettingInfo | Input settings. For the type RTMP_PUSH, RTMP_PULL, HLS_PULL, or MP4_PULL, 1 or 2 inputs of the corresponding type can be configured. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Id | String | Input ID |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Sample request
Input Example
https://mdl.tencentcloudapi.com/?Action=CreateStreamLiveInput
&Name=sdad
&Type=RTMP_PUSH
&SecurityGroupIds.0=123
&InputSettings.0.AppName=live
&InputSettings.0.StreamName=test
&<Common request parameters>
Output Example
{
"Response": {
"Id": 111,
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 | Invalid parameter. |
| InvalidParameter.ExceededQuantityLimit | The quantity exceeds the limit. |
| InvalidParameter.InputSettings | Invalid InputSettings. |
| InvalidParameter.Name | Invalid Name. |
| InvalidParameter.NotFound | Not found. |
| InvalidParameter.SecurityGroups | Invalid SecurityGroups. |
| InvalidParameter.Type | Invalid Type. |
Yes
No
Was this page helpful?