设置域名主备流功能开关 - ModifyDomainStreamBackup
功能介绍
设置域名主备流功能开关,可支持同一路流推多个,按照先后顺序定优先级,客户可进行流优先级切换
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/domain/stream-backup
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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信息。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
publish_domain |
是 |
String |
推流域名 |
|
stream_backup_enable |
是 |
Boolean |
主备流开关,默认值为false。true:开启主备流功能,false:关闭主备流功能 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
publish_domain |
String |
推流域名 |
|
stream_backup_enable |
Boolean |
主备流开关,默认值为false。true:开启主备流功能,false:关闭主备流功能 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
设置域名主备流功能开关。
PUT https://{endpoint}/v1/{project_id}/domain/stream-backup
{
"publish_domain" : "live.push.example.com",
"stream_backup_enable" : true
}
响应示例
状态码:200
请求成功
{
"publish_domain" : "live.push.example.com",
"stream_backup_enable" : true
}
状态码:400
请求失败
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
请求失败 |
错误码
请参见错误码。