CreateLivePadRule

Last updated: 2025-10-30 21:48:19

CreateLivePadRule

Last updated: 2025-10-30 21:48:19

1. API Description

Domain name for API request: live.intl.tencentcloudapi.com.

create a live pad rule.

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: CreateLivePadRule.
Version	Yes	String	Common Params. The value used for this API: 2018-08-01.
Region	No	String	Common Params. This parameter is not required for this API.
DomainName	Yes	String	Domain name for streaming.
TemplateId	Yes	Integer	The template ID.
AppName	No	String	The streaming path is consistent with the AppName in the streaming and playback address. The default value is live.
StreamName	No	String	Stream name. Note: If this parameter is set to a non-empty string, the rule will only work on this push stream.

3. Output Parameters

Parameter Name	Type	Description
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 create a live pad rule

Input Example

{
    "TemplateId": "1000",
    "AppName": "live",
    "StreamName": "stream1",
    "DomainName": "5000.livepush.myqcloud.com"
}

Output Example

{
    "Response": {
        "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.

Command Line Interface

Tencent Cloud CLI 3.0

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
FailedOperation.NotFound	No records found.
FailedOperation.RuleAlreadyExist	The rule already exists.
InternalError	Internal error.
InternalError.ArgsNotMatch	For the transcoding template adding API.
InternalError.ConfInUsed	The template is in use.
InternalError.ConfNotFound	The template does not exist.
InternalError.InvalidInput	Parameter check failed.
InternalError.NotFound	The record does not exist.
InternalError.RuleAlreadyExist	The rule has already been configured.
InternalError.RuleInUsing	The rule is in use.
InvalidParameter	Invalid parameter.
InvalidParameter.DomainFormatError	The domain name format is incorrect. Please enter a valid one.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Parameter missing.
ResourceNotFound.ForbidService	You are blocked.
ResourceNotFound.FreezeService	Service suspended.
ResourceNotFound.StopService	The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first.
ResourceNotFound.UserDisableService	You disabled the service.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud