10.3 停止单流任务
10.1 启动单流任务
功能介绍
调用此接口接口启动单流任务。
API触发单流录制流名规则：{jobtype}_{jobid}_{roomid}_{userid}
jobtype取值为's'代表单流录制。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/apps/{app_id}/individual-stream-jobs
表10-1 路径参数
参数 是否必选 参数类型 描述
app_id 是 String 应用id
API 参考 10 单流任务管理
请求参数
表10-2 请求 Header 参数
参数 是否必选 参数类型 描述
Content-Type 是 String 内容类型。
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信息。
表10-3 请求 Body 参数
参数 是否必选 参数类型 描述
room_id 是 String 房间id
user_id 是 String 选看的用户id，单个录制任务内 保证唯一
video_type 否 String 标识视频流的类型，可选摄像头 流或者屏幕分享流，未填写表示 不录制视频。
● CAMERASTREAM：摄像头 视频流
● SCREENSTREAM：屏幕分享 视频流
默认为CAMERASTREAM。
API 参考 10 单流任务管理
参数 是否必选 参数类型 描述
m 否 PublishPara
m object 转推参数 record_param 否 RecordParam
object 录制参数
表10-4 PublishParam
参数 是否必选 参数类型 描述
rtmp_urls 是 Array of
strings 合流任务完成后，转推的RTMP 推流地址。
表10-5 RecordParam
参数 是否必选 参数类型 描述
record_rule_id 是 String 录制规则id。
响应参数
状态码： 201
API 参考 10 单流任务管理
表10-6 响应 Header 参数
参数 参数类型 描述
X-request-Id String 此字段携带请求ID号，以便任务跟踪。
表10-7 响应 Body 参数
参数 参数类型 描述
job_id String 任务编号 stream_name String 流名 app_id String 应用id room_id String 房间id
user_id String 选看的用户id，单个录制任务内保证唯一 is_record_audi
o Boolean 是否录制音频。
● true：录制音频
● false：不录制音频 缺省为true。
video_type String 标识视频流的类型，可选摄像头流或者屏幕分享 流，未填写表示不录制视频。
● CAMERASTREAM：摄像头视频流
● SCREENSTREAM：屏幕分享视频流 默认为CAMERASTREAM。
select_stream
_type String 指定窗口拉取的分辨率档位。
● LD
record_param RecordParam
object 录制参数
API 参考 10 单流任务管理
参数 参数类型 描述
create_time String 创建时间，形如
“2006-01-02T15:04:05.075Z”，时区为：UTC update_time String 更新时间，形如
“2006-01-02T15:04:05.075Z”，时区为：UTC state String 任务状态。
● INIT：任务正在初始化
● RUNNING：任务正在运行
● STOPPED：任务已停止 stop_reason String 任务结束原因
description String 针对任务状态的详细信息描述 start_time String 任务开始时间，形如
“2006-01-02T15:04:05.075Z”，时区为：UTC stop_time String 任务完成时间，形如
“2006-01-02T15:04:05.075Z”，时区为：UTC
表10-8 RecordParam
参数 参数类型 描述
record_rule_id String 录制规则id。
状态码： 400
表10-9 响应 Header 参数
参数 参数类型 描述
X-request-Id String 此字段携带请求ID号，以便任务跟踪。
表10-10 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
状态码： 404
API 参考 10 单流任务管理
表10-11 响应 Header 参数
参数 参数类型 描述
X-request-Id String 此字段携带请求ID号，以便任务跟踪。
表10-12 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
状态码： 500
表10-13 响应 Header 参数
参数 参数类型 描述
X-request-Id String 此字段携带请求ID号，以便任务跟踪。
表10-14 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
POST https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/individual-stream-jobs { "room_id" : 100,
"user_id" : "user001", "is_record_audio" : true,
"video_type" : "CAMERASTREAM", "select_stream_type" : "FHD", "max_idle_time" : 30, "record_param" : {
"record_rule_id" : "5f5e172b9016ed5b0961a43"
}}
响应示例
状态码： 201
任务创建成功，返回job的概要信息，如包含job_id
API 参考 10 单流任务管理
{ "job_id" : 1, "app_id" : 1, "room_id" : 100, "user_id" : "user001", "is_record_audio" : true,
"video_type" : "CAMERASTREAM", "select_stream_type" : "FHD", "max_idle_time" : 30, "publish_param" : {
"rtmp_urls" : [ "rtmp://your.rtmp-server.com" ] }, "record_param" : {
"record_rule_id" : "5f5e172b9016ed5b0961a43"
}, "create_time" : "2006-01-02T15:04:05.075Z", "start_time" : "2006-01-02T15:04:05.075Z"
}
状态码： 400
创建单流任务失败，语义有误，当前请求无法被服务器理解，或参数有误
{ "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue"
}
状态码： 404
创建单流任务失败，应用不存在
{ "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue"
}
状态码： 500
创建单流任务失败，服务器错误
{ "error_code" : "RTC.00002xxx", "error_msg" : "InternalError"
}
状态码
状态码 描述
201 任务创建成功，返回job的概要信息，如包含job_id
400 创建单流任务失败，语义有误，当前请求无法被服务器理解，或参数有