更新时间:2024-03-25 GMT+08:00
分享

创建录制规则

功能介绍

创建录制规则接口,录制规则对新推送的流生效,对已经推送中的流不生效。使用此功能将产生直播录制费用。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/record/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必填,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必填,请求的发生时间。

X-Project-Id

String

使用AK/SK方式认证时必填,携带项目ID信息。

表3 请求Body参数

参数

是否必选

参数类型

描述

publish_domain

String

直播推流域名

app

String

应用名,如需匹配任意应用则填写*。录制规则匹配的时候,优先精确app匹配,如果匹配不到,则匹配*

stream

String

录制的流名,如需匹配任流名则填写*。录制规则匹配的时候,优先精确stream匹配,如果匹配不到,则匹配*

record_type

String

录制类型,包括:CONTINUOUS_RECORD,COMMAND_RECORD。默认CONTINUOUS_RECORD。

  • CONTINUOUS_RECORD:持续录制,在该规则类型配置后,只要有流到推送到录制系统,就触发录制。
  • COMMAND_RECORD:命令录制,在该规则类型配置后,在流推送到录制系统后,租户需要通过命令控制该流的录制开始和结束。

default_record_config

DefaultRecordConfig object

默认录制规则配置

表4 DefaultRecordConfig

参数

是否必选

参数类型

描述

record_format

Array of strings

录制格式,当前支持:FLV,HLS,MP4三种格式,设置格式时必须使用大写字母

obs_addr

RecordObsFileAddr object

录制保存的租户的桶信息

hls_config

HLSRecordConfig object

HLS配置规则

flv_config

FLVRecordConfig object

FLV配置规则

mp4_config

MP4RecordConfig object

MP4配置规则

表5 RecordObsFileAddr

参数

是否必选

参数类型

描述

bucket

String

OBS的bucket名称

location

String

OBS Bucket所在RegionID

object

String

OBS对象路径,遵守OBS Object定义。如果为空则保存到根目录

表6 HLSRecordConfig

参数

是否必选

参数类型

描述

record_cycle

Integer

周期录制时长 单位:秒,最小1分钟(60秒),最大12小时(43200秒)。 如果为0,则使用默认值6小时(21600秒)。

record_prefix

String

录制m3u8文件,含路径和文件名的前缀, 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time}

record_ts_prefix

String

录制ts文件名的前缀, 默认{file_start_time_unix}_{file_end_time_unix}_{ts_sequence_number}

record_slice_duration

Integer

录制HLS时ts的切片时长,非必填。 取值范围:[2,60] 单位:秒 默认值:10

record_max_duration_to_merge_file

Integer

录制HLS文件拼接时长,如果流中断超过该时间,则生成新文件。 单位:秒 默认值:0

  • 0:表示流中断就生成新文件。
  • -1:表示相同的流中断恢复后,继续在30天内的前一个文件保存。
表7 FLVRecordConfig

参数

是否必选

参数类型

描述

record_cycle

Integer

周期录制时长 单位:秒,最小1分钟(60秒),最大6小时(21600秒)。 如果为0,则使用默认值2小时(7200秒)。

record_prefix

String

录制FLV文件,含路径和文件名的前缀, 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}

record_max_duration_to_merge_file

Integer

录制FLV文件拼接时长,如果流中断超过该时间,则生成新文件。如果为0表示流中断就生成新文件。 单位:秒 默认值:0

表8 MP4RecordConfig

参数

是否必选

参数类型

描述

record_cycle

Integer

周期录制时长 单位:秒,最小1分钟(60秒),最大6小时(21600秒)。 如果为0,则使用默认值2小时(7200秒)。

record_prefix

String

录制文件含路径和文件名的前缀, 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}

record_max_duration_to_merge_file

Integer

录制mp4文件拼接时长,如果流中断超过该时间,则生成新文件。如果为0表示流中断就生成新文件。 单位:秒 默认值:0

响应参数

状态码: 201

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称)

表10 响应Body参数

参数

参数类型

描述

id

String

规则ID,由服务端返回。创建或修改的时候不携带

publish_domain

String

直播推流域名

app

String

应用名,如果需要匹配任意应用则需填写*。录制规则匹配的时候,优先精确app匹配,如果匹配不到,则匹配*

stream

String

录制的流名,如果需要匹配任意流名则需填写*。录制规则匹配的时候,优先精确stream匹配,如果匹配不到,则匹配*

record_type

String

录制类型,包括:CONTINUOUS_RECORD,COMMAND_RECORD。默认CONTINUOUS_RECORD。

  • CONTINUOUS_RECORD:持续录制,在该规则类型配置后,只要有流推送到录制系统,即触发录制。
  • COMMAND_RECORD:命令录制,在该规则类型配置后,在流推送到录制系统后,租户需要通过命令控制该流的录制开始和结束。

default_record_config

DefaultRecordConfig object

默认录制规则配置

create_time

String

创建时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间。 在查询的时候返回

update_time

String

修改时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间。 在查询的时候返回

表11 DefaultRecordConfig

参数

参数类型

描述

record_format

Array of strings

录制格式,当前支持:FLV,HLS,MP4三种格式,设置格式时必须使用大写字母

obs_addr

RecordObsFileAddr object

录制保存的租户的桶信息

hls_config

HLSRecordConfig object

HLS配置规则

flv_config

FLVRecordConfig object

FLV配置规则

mp4_config

MP4RecordConfig object

MP4配置规则

表12 RecordObsFileAddr

参数

参数类型

描述

bucket

String

OBS的bucket名称

location

String

OBS Bucket所在RegionID

object

String

OBS对象路径,遵守OBS Object定义。如果为空则保存到根目录

表13 HLSRecordConfig

参数

参数类型

描述

record_cycle

Integer

周期录制时长 单位:秒,最小1分钟(60秒),最大12小时(43200秒)。 如果为0,则使用默认值6小时(21600秒)。

record_prefix

String

录制m3u8文件,含路径和文件名的前缀, 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time}

record_ts_prefix

String

录制ts文件名的前缀, 默认{file_start_time_unix}_{file_end_time_unix}_{ts_sequence_number}

record_slice_duration

Integer

录制HLS时ts的切片时长,非必填。 取值范围:[2,60] 单位:秒 默认值:10

record_max_duration_to_merge_file

Integer

录制HLS文件拼接时长,如果流中断超过该时间,则生成新文件。 单位:秒 默认值:0

  • 0:表示流中断就生成新文件。
  • -1:表示相同的流中断恢复后,继续在30天内的前一个文件保存。
表14 FLVRecordConfig

参数

参数类型

描述

record_cycle

Integer

周期录制时长 单位:秒,最小1分钟(60秒),最大6小时(21600秒)。 如果为0,则使用默认值2小时(7200秒)。

record_prefix

String

录制FLV文件,含路径和文件名的前缀, 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}

record_max_duration_to_merge_file

Integer

录制FLV文件拼接时长,如果流中断超过该时间,则生成新文件。如果为0表示流中断就生成新文件。 单位:秒 默认值:0

表15 MP4RecordConfig

参数

参数类型

描述

record_cycle

Integer

周期录制时长 单位:秒,最小1分钟(60秒),最大6小时(21600秒)。 如果为0,则使用默认值2小时(7200秒)。

record_prefix

String

录制文件含路径和文件名的前缀, 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}

record_max_duration_to_merge_file

Integer

录制mp4文件拼接时长,如果流中断超过该时间,则生成新文件。如果为0表示流中断就生成新文件。 单位:秒 默认值:0

状态码: 400

表16 响应Header参数

参数

参数类型

描述

X-request-id

String

此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称)

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

创建录制规则。

POST https://{endpoint}/v1/{project_id}/record/rules

{
  "publish_domain" : "publish.xxx.com",
  "app" : "live",
  "stream" : "*",
  "record_type" : "CONTINUOUS_RECORD",
  "default_record_config" : {
    "record_format" : [ "HLS", "FLV" ],
    "hls_config" : {
      "record_cycle" : 3600,
      "record_prefix" : "Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}",
      "record_ts_prefix" : "{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}",
      "record_slice_duration" : 10,
      "record_max_duration_to_merge_file" : 0
    },
    "flv_config" : {
      "record_cycle" : 9000,
      "record_prefix" : "Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}",
      "record_max_duration_to_merge_file" : 0
    },
    "obs_addr" : {
      "bucket" : "mybucket",
      "location" : "region1",
      "object" : "record/"
    }
  }
}

响应示例

状态码: 400

创建录制规则操作失败

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

SDK代码示例

SDK代码示例如下。

创建录制规则。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateRecordRuleSolution {

    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");

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

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateRecordRuleRequest request = new CreateRecordRuleRequest();
        RecordRuleRequest body = new RecordRuleRequest();
        FLVRecordConfig flvConfigDefaultRecordConfig = new FLVRecordConfig();
        flvConfigDefaultRecordConfig.withRecordCycle(9000)
            .withRecordPrefix("Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}")
            .withRecordMaxDurationToMergeFile(0);
        HLSRecordConfig hlsConfigDefaultRecordConfig = new HLSRecordConfig();
        hlsConfigDefaultRecordConfig.withRecordCycle(3600)
            .withRecordPrefix("Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}")
            .withRecordTsPrefix("{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}")
            .withRecordSliceDuration(10)
            .withRecordMaxDurationToMergeFile(0);
        RecordObsFileAddr obsAddrDefaultRecordConfig = new RecordObsFileAddr();
        obsAddrDefaultRecordConfig.withBucket("mybucket")
            .withLocation(RecordObsFileAddr.LocationEnum.fromValue("region1"))
            .withObject("record/");
        List<VideoFormatVar> listDefaultRecordConfigRecordFormat = new ArrayList<>();
        listDefaultRecordConfigRecordFormat.add(VideoFormatVar.fromValue("HLS"));
        listDefaultRecordConfigRecordFormat.add(VideoFormatVar.fromValue("FLV"));
        DefaultRecordConfig defaultRecordConfigbody = new DefaultRecordConfig();
        defaultRecordConfigbody.withRecordFormat(listDefaultRecordConfigRecordFormat)
            .withObsAddr(obsAddrDefaultRecordConfig)
            .withHlsConfig(hlsConfigDefaultRecordConfig)
            .withFlvConfig(flvConfigDefaultRecordConfig);
        body.withDefaultRecordConfig(defaultRecordConfigbody);
        body.withRecordType(RecordRuleRequest.RecordTypeEnum.fromValue("CONTINUOUS_RECORD"));
        body.withStream("*");
        body.withApp("live");
        body.withPublishDomain("publish.xxx.com");
        request.withBody(body);
        try {
            CreateRecordRuleResponse response = client.createRecordRule(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());
        }
    }
}

创建录制规则。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = CreateRecordRuleRequest()
        flvConfigDefaultRecordConfig = FLVRecordConfig(
            record_cycle=9000,
            record_prefix="Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}",
            record_max_duration_to_merge_file=0
        )
        hlsConfigDefaultRecordConfig = HLSRecordConfig(
            record_cycle=3600,
            record_prefix="Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}",
            record_ts_prefix="{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}",
            record_slice_duration=10,
            record_max_duration_to_merge_file=0
        )
        obsAddrDefaultRecordConfig = RecordObsFileAddr(
            bucket="mybucket",
            location="region1",
            object="record/"
        )
        listRecordFormatDefaultRecordConfig = [
            "HLS",
            "FLV"
        ]
        defaultRecordConfigbody = DefaultRecordConfig(
            record_format=listRecordFormatDefaultRecordConfig,
            obs_addr=obsAddrDefaultRecordConfig,
            hls_config=hlsConfigDefaultRecordConfig,
            flv_config=flvConfigDefaultRecordConfig
        )
        request.body = RecordRuleRequest(
            default_record_config=defaultRecordConfigbody,
            record_type="CONTINUOUS_RECORD",
            stream="*",
            app="live",
            publish_domain="publish.xxx.com"
        )
        response = client.create_record_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建录制规则。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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")

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

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

    request := &model.CreateRecordRuleRequest{}
	recordPrefixFlvConfig:= "Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}"
	recordMaxDurationToMergeFileFlvConfig:= int32(0)
	flvConfigDefaultRecordConfig := &model.FlvRecordConfig{
		RecordCycle: int32(9000),
		RecordPrefix: &recordPrefixFlvConfig,
		RecordMaxDurationToMergeFile: &recordMaxDurationToMergeFileFlvConfig,
	}
	recordPrefixHlsConfig:= "Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}"
	recordTsPrefixHlsConfig:= "{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}"
	recordSliceDurationHlsConfig:= int32(10)
	recordMaxDurationToMergeFileHlsConfig:= int32(0)
	hlsConfigDefaultRecordConfig := &model.HlsRecordConfig{
		RecordCycle: int32(3600),
		RecordPrefix: &recordPrefixHlsConfig,
		RecordTsPrefix: &recordTsPrefixHlsConfig,
		RecordSliceDuration: &recordSliceDurationHlsConfig,
		RecordMaxDurationToMergeFile: &recordMaxDurationToMergeFileHlsConfig,
	}
	obsAddrDefaultRecordConfig := &model.RecordObsFileAddr{
		Bucket: "mybucket",
		Location: model.GetRecordObsFileAddrLocationEnum().REGION1,
		Object: "record/",
	}
	var listRecordFormatDefaultRecordConfig = []model.VideoFormatVarRecordFormat{
        model.GetVideoFormatVarRecordFormatEnum().HLS,
	    model.GetVideoFormatVarRecordFormatEnum().FLV,
    }
	defaultRecordConfigbody := &model.DefaultRecordConfig{
		RecordFormat: listRecordFormatDefaultRecordConfig,
		ObsAddr: obsAddrDefaultRecordConfig,
		HlsConfig: hlsConfigDefaultRecordConfig,
		FlvConfig: flvConfigDefaultRecordConfig,
	}
	recordTypeRecordRuleRequest:= model.GetRecordRuleRequestRecordTypeEnum().CONTINUOUS_RECORD
	request.Body = &model.RecordRuleRequest{
		DefaultRecordConfig: defaultRecordConfigbody,
		RecordType: &recordTypeRecordRuleRequest,
		Stream: "*",
		App: "live",
		PublishDomain: "publish.xxx.com",
	}
	response, err := client.CreateRecordRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

创建录制规则操作成功

400

创建录制规则操作失败

错误码

请参见错误码

分享:

    相关文档

    相关产品