# 更新自动录制配置 - UpdateAutoRecord #### 功能介绍 更新自动录制配置，租户可以开启自动单流录制或者停用自动单流录制（仅支持单流录制）。 #### 接口约束 开启自动单流录制功能之后，只针对新创建的房间有效，对开启自动录制功能之前已经创建的房间不生效。 单流自动录制任务的流名规则： {appid}_{roomid}_{userid}_{media_type}_{video_type} {media_type}可取值为v（代表纯视频录制），av（代表音视频录制）。 {video_type}可取值为m（代表录主流摄像头视频），a（代表录辅流视频）。 可能的组合有_av_m（自动录制主流和音频）和_v_a（自动录制辅流视频，无音频）。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudRTC/doc?api=UpdateAutoRecord)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rtc/rtc_07_0022.html)。 #### URI PUT /v2/apps/{app_id}/auto-record-mode 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | app_id | 是 | String | 应用id | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | 内容类型。取值application/json。 | | 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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | mode | 是 | String | 录制模式。 - AUTO_RECORD_OFF：关闭自动录制。 - AUTO_INDIVIDUAL_RECORD：开启单流自动录制，此时record_rule_id必须非空。 | | record_rule_id | 否 | String | 录制规则id。 | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-Id | String | 此字段携带请求ID号，以便任务跟踪。 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | app_id | String | 应用id | | auto_record_mode | [AppAutoRecordMode] object | 自动录制配置 | 表6AppAutoRecordMode | 参数 | 参数类型 | 描述 | |:---|:---|:---| | mode | String | 录制模式。 - AUTO_RECORD_OFF：关闭自动录制。 - AUTO_INDIVIDUAL_RECORD：开启单流自动录制，此时record_rule_id必须非空。 | | record_rule_id | String | 录制规则id。 | | update_time | String | 更新时间，形如"2006-01-02T15:04:05.075Z"，时区为：UTC。 | **状态码：400** 表7响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-Id | String | 此字段携带请求ID号，以便任务跟踪。 | 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：404** 表9响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-Id | String | 此字段携带请求ID号，以便任务跟踪。 | 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：500** 表11响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-Id | String | 此字段携带请求ID号，以便任务跟踪。 | 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 更新指定应用id的自动录制配置，配置为关闭自动录制 ``` PUT https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/auto-record-mode { "mode" : "AUTO_RECORD_OFF" } ``` #### 响应示例 **状态码：200** 任务创建成功，返回app的概要信息，如包含app_id ``` { "app_id" : "123456789abcdefghijklmno", "auto_record_mode" : { "mode" : "AUTO_RECORD_OFF", "update_time" : "2020-07-26T07:53: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" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 任务创建成功，返回app的概要信息，如包含app_id | | 400 | 更新自动录制任务失败，语义有误，当前请求无法被服务器理解，或参数有误 | | 404 | 更新自动录制任务失败，应用不存在 | | 500 | 更新自动录制任务失败，服务器错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rtc/ErrorCode.html)。