Help Center/ Live/ Cloud Live API Reference/ Recording Management/ Querying Recording Templates

Updated on 2026-08-19 GMT+08:00

Querying Recording Templates

Function

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

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

live:record:listRules

Read

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
live:record:listRules	Read	-	-	-	-

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	Definition Ingest domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A
app	No	String	Definition Application name. Constraints N/A Range Length: 1 to 128 characters Default Value N/A
stream	No	String	Definition Stream name. Constraints N/A Range Length: 1 to 512 characters Default Value N/A
record_type	No	String	Definition Recording type. Constraints N/A Range 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 Value N/A
offset	No	Integer	Definition Offset where the query starts. Constraints N/A Value range: 0~4096 Default value: 0
limit	No	Integer	Definition Number of records on each page. Constraints N/A Value range: 1~100 Default value: 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	Definition Total number of records. Value range: 0~1024000
record_config	Array of RecordRule objects	Definition Recording template array.

**Table 6** RecordRule
Parameter	Type	Description
id	String	Definition Template ID, which is returned by the server. This parameter is not required for creation or modification. Range N/A
publish_domain	String	Definition Ingest domain name. Range Length: 1 to 255 characters
app	String	Definition Application name. Range Length: 1 to 128 characters Exact application matching takes precedence. If no match is found, the wildcard (*) rule is applied.
stream	String	Definition Stream name. Range Length: 1 to 512 characters Exact stream matching takes precedence. If no match is found, the wildcard (*) rule is applied.
record_type	String	Definition Recording type. Range 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	Definition Default recording template settings.
create_time	String	Definition Creation time in the format of yyyy-mm-ddThh:mm:ssZ (UTC time). It is returned in the response. Range N/A
update_time	String	Definition Modification time in the format of yyyy-mm-ddThh:mm:ssZ (UTC time). It is returned in the response. Range N/A

**Table 7** DefaultRecordConfig
Parameter	Type	Description
record_format	Array of strings	Definition Recording format.
obs_addr	RecordObsFileAddr object	Definition Information of your bucket where recordings are stored.
hls_config	HLSRecordConfig object	Definition HLS configuration.
flv_config	FLVRecordConfig object	Definition FLV configuration.
mp4_config	MP4RecordConfig object	Definition MP4 configuration.

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

**Table 9** HLSRecordConfig
Parameter	Type	Description
record_cycle	Integer	Definition Recording duration, in seconds. 0, the default value 6 hours (21,600 seconds) is used. Value range: 0~43200
record_prefix	String	Definition Prefix for the M3U8 recording file, including the file path and file name. Range Length: 1 to 512 characters
record_ts_prefix	String	Definition Prefix for the TS recording file name. Range Length: 1 to 512 characters
record_slice_duration	Integer	Definition (Optional) TS segment duration for HLS recording. Value range: 2~60
record_max_duration_to_merge_file	Integer	Definition Interval threshold for combining HLS segments, in seconds. If the stream interruption duration exceeds this threshold, a new file will be generated. 0: A new file will be generated once the stream is interrupted. –1: After the stream is resumed within 30 days, the recording will append to the previous file. Value range: -1~300

**Table 10** FLVRecordConfig
Parameter	Type	Description
record_cycle	Integer	Definition Recording duration, in seconds. 0, the default value 2 hours (7,200 seconds) is used. Value range: 0~21600
record_prefix	String	Definition Prefix for the FLV recording file, including the file path and file name. Range Length: 1 to 512 characters
record_max_duration_to_merge_file	Integer	Definition Interval threshold for combining FLV segments, in seconds. 0, a new file will be generated once the stream is interrupted. Value range: 0~300

**Table 11** MP4RecordConfig
Parameter	Type	Description
record_cycle	Integer	Definition Recording duration, in seconds. 0, the default value 2 hours (7,200 seconds) is used. Value range: 0~21600
record_prefix	String	Definition Prefix for the recording file, including the file path and file name. Range Length: 1 to 512 characters
record_max_duration_to_merge_file	Integer	Definition Interval threshold for combining MP4 segments, in seconds. 0, a new file will be generated once the stream is interrupted. Unit: second Value range: 0~300

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 templates.

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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := live.LiveClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := live.NewLiveClient(hcClient)

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

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code	Description
200	Query succeeded.
400	Incorrect parameter.

Error Codes

See Error Codes.

Parent Topic: Recording Management

Previous topic: Creating a Recording Template

Next topic: Modifying a Recording Template