修改频道状态 - ModifyOttChannelInfoStats
功能介绍
修改频道状态。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| live:ott:updateChannelState | Write | - | - | - | - |
URI
PUT /v1/{project_id}/ott/channels/state
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参考获取项目ID。 约束限制: 不涉及 取值范围: [1,32] 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 用户Token,使用Token鉴权方式时为必填项。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: [1,256] 默认取值: 不涉及 |
| Authorization | 否 | String | 参数解释: 使用AK/SK方式认证时必填,携带的鉴权信息。 约束限制: 不涉及 取值范围: [1,256] 默认取值: 不涉及 |
| X-Sdk-Date | 否 | String | 参数解释: 请求的发生时间,使用AK/SK方式认证时为必填项。 约束限制: 不涉及 取值范围: [1,256] 默认取值: 不涉及 |
| X-Project-Id | 否 | String | 参数解释: 使用AK/SK方式认证时为必填项,携带项目ID信息。 约束限制: 不涉及 取值范围: [1,64] 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain | 是 | String | 参数解释: 频道推流域名 约束限制: 不涉及 取值范围: 只能由小写英文字符与"-"、"_"组成,且长度为[1~255]个字符。 默认取值: 不涉及 |
| app_name | 是 | String | 参数解释: 组名或应用名 约束限制: 不涉及 取值范围: 只能由英文字符与"-"、"_"组成,首字符必须为字母。且长度为[1~64]个字符。 默认取值: 不涉及 |
| id | 是 | String | 参数解释: 频道ID,频道唯一标识。 约束限制: 不涉及 取值范围: 只能由英文字符与"-"、"_"组成,首字符必须为字母。且长度为[2~64]个字符。 默认取值: 不涉及 |
| state | 是 | String | 参数解释: 频道状态 约束限制: 不涉及 取值范围: 默认取值: ON |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result_code | String | 参数解释: 错误码 取值范围: 详见错误码。 |
| result_msg | String | 参数解释: 错误描述 取值范围: 详见错误码描述。 |
| domain | String | 参数解释: 推流域名,响应参数不涉及。 取值范围: 不涉及 |
| app_name | String | 参数解释: 组名或应用名,响应参数不涉及。 取值范围: 不涉及 |
| id | String | 参数解释: 频道ID,频道唯一标识。响应参数不涉及。 取值范围: 不涉及 |
| sources | Array of SourceRsp objects | 参数解释: 推流URL列表,最多返回12条。创建频道时,只有入流协议为RTMP_PUSH、SRT_PUSH时,会返回推流URL列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| url | String | 参数解释: 频道源流URL,用于外部拉流 取值范围: 长度限制[1~1024]个字符 |
| bitrate | Integer | 参数解释: 码率,单位:bps 取值范围: 0~104857600 |
| width | Integer | 参数解释: 分辨率对应宽的值 取值范围: 0~4096 |
| height | Integer | 参数解释: 分辨率对应高的值 取值范围: 0~2160 |
| enable_snapshot | Boolean | 参数解释: 描述是否使用该流做截图 取值范围: |
状态码:400
请求示例
PUT https://{endpoint}/v1/{project_id}/ott/channels/state
{
"domain" : "push.testott.hls.com",
"app_name" : "ott",
"id" : "test",
"state" : "ON"
} 响应示例
状态码:200
Demo Information
{
"result_code" : "LIVE.100000000",
"result_msg" : "SUCCESS",
"domain" : "push.testott.hls.com",
"app_name" : "ott",
"id" : "test"
} 状态码:400
Error response
{
"result_code" : "LIVE.100011001",
"result_msg" : "Request parameters is invalid, channel state has been turned OFF",
"domain" : "push.testott.hls.com",
"app_name" : "ott",
"id" : "test"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Demo Information |
| 400 | Error response |
错误码
请参见错误码。