调用CreateAutoLiveStreamRule创建自动旁路单路转推规则。

使用说明

本接口用于创建旁路规则。

QPS限制

本接口的单用户QPS限制为1000次/分钟。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateAutoLiveStreamRule

系统规定参数。取值：CreateAutoLiveStreamRule。

AppId String 是 eo85****

应用ID，可通过控制台创建和查询。
PlayDomain String 是 rtmp://${domain}/${app}/${stream}

自动旁路的播流域名。自动旁路任务对应播流地址为rtmp://${domain}/${app}/${stream}。

  • domain: 您的直播播流域名。
  • app: live。
  • stream: urlencode(${AppId}_${ChannelId}_${UserId}_${SourceType})，其中SourceType为输入源类型。
RuleName String 否 testRule

旁路规则名称。
CallBack String 否 http://example.com/callback

开启和结束旁路的回调地址。回调内容请参见下文中的CallBack回调示例。
MediaEncode Integer 否 20

编码选项，请参见下文中的MediaEncode枚举值。
ChannelIds.N String 否 12333

精确匹配的频道ID。

说明 ChannelIds和ChannelIdPrefixes参数只能二选一输入或者都不输入，如果都不输入，则表示进行应用ID维度的自动旁路单路转推。
ChannelIdPrefixes.N String 否 12

模糊匹配频道ID的前缀。

说明 ChannelIds和ChannelIdPrefixes参数只能二选一输入或者都不输入，如果都不输入，则表示进行应用ID维度的自动旁路单路转推。

CallBack回调示例


{
    "RequestId": "udie-jfieu89-34jfi-7jjifk",
    "AppId": "pdtkb2qy",
    "ChannelId": "0122",
    "TaskId": "AL-1f43957a8e58fedef9b568b9c9ebddc0-1613618364",
    "UserId": "2d0069089df36b22",
    "SourceType": "camera",
    "RuleId": 40,
    "Event": "StartAutoLiveStreamTask",
    "Description": "success"
}

参数

类型

是否必填

描述

RequestId

String

是

请求ID。

AppId

String

是

应用ID。

ChannelId

String

是

频道ID。

TaskId

String

是

任务ID，生成规则为AL-MD5(rtmp://${domain}/${app}/${stream})。

UserId

String

是

用户ID。

SourceType

String

是

输入源类型，取值：

  • camera：摄像头视频流。
  • shareScreen：共享视频流。

RuleId

Long

是

旁路规则ID。

Event

String

是

事件类型，取值：

  • StartAutoLiveStreamTask：开启自动旁路单路转推任务。
  • StopAutoLiveStreamTask：停止自动旁路单路转推任务。

Description

String

是

事件描述。

MediaEncode枚举值

ID

宽

高

码流（Kps）

帧率（FPS）

0

0

0

64

0

1

640

360

500

15

54

360

640

500

30

53

360

640

500

15

52

640

360

500

30

10

960

540

700

24

20

1280

720

1024

25

22

720

1280

1024

30

23

800

600

1024

30

30

1920

1080

2048

30

31

1080

1920

2048

30

24

750

780

1024

30

25

750

540

700

30

26

720

1280

2048

30

27

1280

720

2048

30

28

1280

720

3096

30

32

1024

768

1024

24

33

1280

960

1024

24

34

1024

768

2048

24

35

1280

960

2048

24

36

1280

720

1024

24

37

1280

720

2048

24

38

540

960

750

15

39

540

960

1500

30

40

1280

720

1200

15

41

720

1280

1200

15

42

720

1280

1500

15

43

540

960

1200

15

返回数据

名称 类型 示例值 描述
RuleId Long 12

旁路规则ID。
RequestId String 760bad53276431c499e30dc36f6b26be

请求ID。

示例

请求示例

http(s)://rtc.aliyuncs.com/?Action=CreateAutoLiveStreamRule
&AppId=eo85****
&PlayDomain=rtmp://${domain}/${app}/${stream}
&CallBack=http://example.com/callback
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateAutoLiveStreamRuleResponse>
    <RuleId>12</RuleId>
    <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>
</CreateAutoLiveStreamRuleResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RuleId" : 12,
  "RequestId" : "760bad53276431c499e30dc36f6b26be"
}