创建状态为未开播的新直播。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用加粗字体表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
imp:CreateLive | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 应用唯一标识,可以包含小写字母、数字,长度为6个字符。 | 7m***q |
RoomId | string | 是 | 房间唯一标识,最大长度36个字符。 | AE35-****-T95F |
UserId | string | 是 | 创建直播用户,在AppId下单独唯一。小写英文、数字、下划线(_)和小数点(.)组成,最大长度32个字符。 | as****hs |
LiveId | string | 否 | 直播资源的唯一标识ID,传空值时,系统自动生成36位随机UUID字符串。 | b7f2****ebb3 |
Title | string | 否 | 直播标题,支持中英文,最大长度256个字符。 | This is a title. |
Introduction | string | 否 | 直播简介,支持中英文,最大长度2048个字符。 | This is an intro. |
AnchorId | string | 否 | 主播ID,支持中英文,最大长度128个字符。传空值时,主播为当前创建直播用户。 | as****hs |
CodeLevel | integer | 否 | 直播推流码率,缺省时默认为3。取值:
| 3 |
返回参数
示例
请求示例
http(s)://[Endpoint]/?Action=CreateLive
&AppId=7m***q
&RoomId=AE35-****-T95F
&UserId=as****hs
&LiveId=b7f2****ebb3
&Title=This is a title.
&Introduction=This is an intro.
&AnchorId=as****hs
&CodeLevel=1
&公共请求参数
正常返回示例
JSON
格式
{
"RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
"Result": {
"LiveId": "b7f2****ebb3"
}
}
XML
格式
<CreateLiveResponse>
<RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
<Result>
<LiveId>b7f2****ebb3</LiveId>
</Result>
</CreateLiveResponse>
错误码
访问错误中心查看更多错误码。