CreateLiveRecordRule

Last updated: 2020-07-01 11:21:26

    1. API Description

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

    To create a recording rule, you need to first call the CreateLiveRecordTemplate API to create a recording template and bind the returned template ID to the stream.

    Recording-related document: LVB Recording.

    A maximum of 200 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 parameter. The value used for this API: CreateLiveRecordRule.
    Version Yes String Common parameter. The value used for this API: 2018-08-01.
    Region No String Common parameter. This parameter is not required for this API.
    DomainName Yes String Push domain name.
    TemplateId Yes Integer Template ID.
    AppName No String Push path, which is the same as the AppName in push and playback addresses and is "live" by default.
    StreamName No String Stream name.
    Note: If the parameter is a non-empty string, the rule will be only applicable to the particular stream.

    3. Output Parameters

    Parameter Name Type Description
    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://live.tencentcloudapi.com/?Action=CreateLiveRecordRule
    &DomainName=5000.livepush.myqcloud.com
    &AppName=live
    &StreamName=stream1
    &TemplateId=1000
    &<Common request parameter>

    Output Example

    {
      "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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.
    InternalError.ArgsNotMatch For the transcoding template adding API.
    InternalError.ConfInUsed The template is in use.
    InternalError.ConfOutLimit The number of templates exceeds the limit.
    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.
    InternalError.RuleOutLimit The rule exceeds the limit.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Wrong parameter value.
    MissingParameter Missing parameter.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help