Querying Recording Templates

Function

This API is used to query recording templates that meet specific conditions.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/record/rules

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
publish_domain	No	String	Ingest domain name.
app	No	String	Application name.
stream	No	String	Stream name.
record_type	No	String	Recording type. If this parameter is left empty, templates of all recording types are queried. The value can be CONTINUOUS_RECORD or COMMAND_RECORD. The default value is CONTINUOUS_RECORD. CONTINUOUS_RECORD: continuous recording. Recording is triggered when streams are pushed to the recording system. COMMAND_RECORD: command-based recording. After streams are pushed to the recording system, you must run commands to start and stop stream recording.
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0.
limit	No	Integer	Number of records on each page. The value ranges from 1 to 100 and defaults to 10.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication.
X-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp indicates the current timestamp, and hostname is the name of the server that processes the current API.)

**Table 5** Response body parameters
Parameter	Type	Description
total	Integer	Total number of elements in the query result.
record_config	Array of RecordRule objects	Recording template array.

**Table 6** RecordRule
Parameter	Type	Description
id	String	Rule ID, which is returned by the server. This parameter is not needed during creation or modification.
publish_domain	String	Ingest domain name.
app	String	Application name. To match any application, set this parameter to a wildcard character (*). Exact application matching is preferred. If no application is matched, all applications will be matched.
stream	String	Stream name. To match any stream, set this parameter to a wildcard character (*). Exact stream matching is preferred. If no stream is matched, all streams will be matched.
record_type	String	Recording type. The options are CONTINUOUS_RECORD and COMMAND_RECORD. The default value is CONTINUOUS_RECORD. CONTINUOUS_RECORD: continuous recording. Recording is triggered when streams are pushed to the recording system. COMMAND_RECORD: command-based recording. After streams are pushed to the recording system, you must run commands to start and stop stream recording.
default_record_config	DefaultRecordConfig object	Default recording template.
create_time	String	Creation time in the format of yyyy-mm-ddThh:mm:ssZ (UTC time).
update_time	String	Modification time in the format of yyyy-mm-ddThh:mm:ssZ (UTC time).

**Table 7** DefaultRecordConfig
Parameter	Type	Description
record_format	Array of strings	Recording format.
obs_addr	RecordObsFileAddr object	Details about the bucket for storing recordings.
hls_config	HLSRecordConfig object	HLS configuration rule.
flv_config	FLVRecordConfig object	FLV configuration rule.
mp4_config	MP4RecordConfig object	MP4 configuration rule.

**Table 8** RecordObsFileAddr
Parameter	Type	Description
bucket	String	OBS bucket name.
location	String	ID of the region where the OBS bucket resides.
object	String	OBS object path, which complies with the OBS object definition. If this parameter is left empty, recordings will be saved to the root directory.

**Table 9** HLSRecordConfig
Parameter	Type	Description
record_cycle	Integer	Duration of periodic recording. Unit: second. The value ranges from 1 minute (60 seconds) to 12 hours (43,200 seconds). If the value is 0, the default value 6 hours (21,600 seconds) is used.
record_prefix	String	Path and file name prefix of an M3U8 file. The default value is Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}{file_start_time}/{stream}{file_start_time}.
record_ts_prefix	String	TS file name prefix. The default value is {file_start_time_unix}{file_end_time_unix}{ts_sequence_number}.
record_slice_duration	Integer	(Optional) TS slice duration for HLS recording. Value range: [2,60] Unit: second Default value: 10
record_max_duration_to_merge_file	Integer	Interval threshold for combining HLS chunks. If the stream interruption duration exceeds this threshold, a new file will be generated. Unit: second Default value: 0 0: A new file will be generated once the stream is interrupted. –1: After the same stream is resumed, the recording will be saved in the previous file within 30 days.

**Table 10** FLVRecordConfig
Parameter	Type	Description
record_cycle	Integer	Duration of periodic recording. Unit: second. The value ranges from 1 minute (60 seconds) to 6 hours (21,600 seconds). If the value is 0, the default value 2 hours (7,200 seconds) is used.
record_prefix	String	Path and file name prefix of an FLV file. The default value is *Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}.
record_max_duration_to_merge_file	Integer	Interval threshold for combining FLV chunks. If the stream interruption duration exceeds this threshold, a new file will be generated. If the value is set to 0, a new file will be generated once the stream is interrupted. Unit: second Default value: 0

**Table 11** MP4RecordConfig
Parameter	Type	Description
record_cycle	Integer	Duration of periodic recording. Unit: second. The value ranges from 1 minute (60 seconds) to 6 hours (21,600 seconds). If the value is 0, the default value 2 hours (7,200 seconds) is used.
record_prefix	String	Path and file name prefix of the file. The default value is *Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}.
record_max_duration_to_merge_file	Integer	Interval threshold for combining MP4 chunks. If the stream interruption duration exceeds this threshold, a new file will be generated. If the value is set to 0, a new file will be generated once the stream is interrupted. Unit: second Default value: 0

Status code: 400

**Table 12** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp indicates the current timestamp, and hostname is the name of the server that processes the current API.)

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error description

Example Requests

Queries recording rules.

GET https://live.hwcloud.com/v1/{project_id}/record/rules?publish_domain=xxx

Example Responses

Status code: 200

Query succeeded.

{
  "total" : 1,
  "record_config" : [ {
    "id" : "42810594c2fc9xxxx36b7784c76a06e8",
    "publish_domain" : "publish.example.com",
    "app" : "live",
    "stream" : "*",
    "record_type" : "CONTINUOUS_RECORD",
    "default_record_config" : {
      "record_format" : [ "HLS" ],
      "obs_addr" : {
        "bucket" : "mybucket",
        "location" : "region1",
        "object" : "record/"
      },
      "hls_config" : {
        "record_cycle" : 900,
        "record_prefix" : "record-publish_domain-app-stream-file_start_time_unix/record-publish_domain-app-stream-file_start_time_unix",
        "record_ts_prefix" : "{stream}-{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}",
        "record_slice_duration" : 10,
        "record_max_duration_to_merge_file" : 60
      }
    }
  } ]
}

Status code: 400

Incorrect parameter.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v1.region.LiveRegion;
import com.huaweicloud.sdk.live.v1.*;
import com.huaweicloud.sdk.live.v1.model.*;


public class ListRecordRulesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        ListRecordRulesRequest request = new ListRecordRulesRequest();
        try {
            ListRecordRulesResponse response = client.listRecordRules(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v1.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListRecordRulesRequest()
        response = client.list_record_rules(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListRecordRulesRequest{}
	response, err := client.ListRecordRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     