Querying a Recording Template

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

id

Yes

String

Template ID.

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.

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

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

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.

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.

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.

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

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

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

error_code

String

Error Code

error_msg

String

Error description

200

Query succeeded.

400

Query failed.