设置指定发布点下的直播流的自定义录制选项。
PATCH https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/record/custom/regions/{region}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
region |
String | 必填。添加推流域名时设置的区域。 |
请求包体为 JSON Object 类型,包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
mp4Config |
JSON Object | 选填。MP4 录制文件的配置,详见 mp4Config。 |
hlsConfig |
JSON Object | 选填。HLS 录制文件的配置,详见 HlsConfig。 |
storageConfig |
JSON Object | 选填(首次设置录制选项时必填)。录制文件的存储配置,详见 StorageConfig。 |
如果返回的 HTTP 状态码为 200,表示请求成功。
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
PATCH https://api.sd-rtn.com/v1/projects/{your_appid}/fls/entry_points/live/settings/record/custom/regions/cn HTTP/1.1
请求 body
{
"hlsConfig": {
"enabled": true
},
"mp4Config": {
"enabled": true
},
"storageConfig": {
"accessKey": "{your access key}",
"bucket": "{your bucket}",
"region": 3,
"secretKey": "{your secret key}",
"vendor": 2
}
}
响应行
HTTP/1.1 200 OK
获取指定发布点的自定义录制配置。
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/record/custom/regions/{region}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
region |
String | 必填。添加推流域名时设置的区域。 |
如果返回的 HTTP 状态码为 200,表示请求成功,响应包体中包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
mp4Config |
JSON Object | MP4 录制文件的配置,详见 mp4Config。 |
hlsConfig |
JSON Object | HLS 录制文件的配置,详见 HlsConfig。 |
storageConfig |
JSON Object | 录制文件的存储配置,详见 StorageConfig。 |
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
GET https://api.sd-rtn.com/v1/projects/{your_appid}/fls/entry_points/live/settings/record/custom/regions/cn HTTP/1.1
响应行
HTTP/1.1 200 OK
响应 body
{
"hlsConfig": {
"enabled": true
},
"mp4Config": {
"enabled": true
},
"storageConfig": {
"accessKey": "{your accesskey}",
"region": 3,
"bucket": "{your bucket}",
"secretKey": "{your secretkey}",
"vendor": 2
}
}
MP4 录制文件的配置,包含以下字段:
enabled
:Bool 型,可选参数。是否启用 MP4 格式的录制。
HLS 录制文件的配置,包含以下字段:
enabled
:Bool 型,可选参数。是否启用 HLS 格式的录制。
录制文件的存储设置,包含以下字段:
vendor
:Number 类型,第三方云存储平台。
region
:Number 类型,第三方云存储指定的地区信息。录制服务仅支持以下列表中的地区。
region
与你发起请求的应用服务器必须在同一个区域中。例如:你发起请求的应用服务器在中国大陆地区,则第三方云存储需要设置为中国大陆区域内。vendor
= 1,即第三方云存储为 Amazon S3 时:0
:US_EAST_11
:US_EAST_22
:US_WEST_13
:US_WEST_24
:EU_WEST_15
:EU_WEST_26
:EU_WEST_37
:EU_CENTRAL_18
:AP_SOUTHEAST_19
:AP_SOUTHEAST_210
:AP_NORTHEAST_111
:AP_NORTHEAST_212
:SA_EAST_113
:CA_CENTRAL_114
:AP_SOUTH_115
:CN_NORTH_116
:CN_NORTHWEST_118
:AF_SOUTH_119
:AP_EAST_120
:AP_NORTHEAST_321
:EU_NORTH_122
:ME_SOUTH_124
:AP_SOUTHEAST_325
:EU_SOUTH_1vendor
= 2,即第三方云存储为阿里云时:0
:CN_Hangzhou1
:CN_Shanghai2
:CN_Qingdao3
:CN_Beijing4
:CN_Zhangjiakou5
:CN_Huhehaote6
:CN_Shenzhen7
:CN_Hongkong8
:US_West_19
:US_East_110
:AP_Southeast_111
:AP_Southeast_212
:AP_Southeast_313
:AP_Southeast_514
:AP_Northeast_115
:AP_South_116
:EU_Central_117
:EU_West_118
:EU_East_119
:AP_Southeast_620
:CN_Heyuan21
:CN_Guangzhou22
:CN_Chengdu23
:CN_Nanjing24
:CN_Fuzhou25
:CN_Wulanchabu26
:CN_Northeast_227
:CN_Southeast_7vendor
= 3,即第三方云存储为腾讯云时:0
:AP_Beijing_11
:AP_Beijing2
:AP_Shanghai3
:AP_Guangzhou4
:AP_Chengdu5
:AP_Chongqing6
:AP_Shenzhen_FSI7
:AP_Shanghai_FSI8
:AP_Beijing_FSI9
:AP_Hongkong10
:AP_Singapore11
:AP_Mumbai12
:AP_Seoul13
:AP_Bangkok14
:AP_Tokyo15
:NA_Siliconvalley16
:NA_Ashburn17
:NA_Toronto18
:EU_Frankfurt19
:EU_Moscowvendor
= 5,即第三方云存储为 Microsoft Azure 时:region
参数,即使设置也不生效。
vendor
= 6,即第三方云存储为谷歌云时:region
参数,即使设置也不生效。
vendor
= 7,即第三方云存储为华为云时:0
:CN_North_11
:CN_North_42
:CN_East_23
:CN_East_34
:CN_South_15
:CN_Southwest_26
:AP_Southeast_17
:AP_Southeast_28
:AP_Southeast_39
:AF_South_110
:SA_Argentina_111
:SA_Peru_112
:NA_Mexico_113
:SA_Brazil_114
:LA_South_215
:SA_Chile_1vendor
= 8,即第三方云存储为百度智能云时:0
:Beijing1
:Baoding2
:Suzhou3
:Guangzhou4
:Hongkong5
:Singapore6
:Wuhan7
:Shanghaibucket
:String 类型,第三方云存储的 bucket,bucket 名称需要符合对应第三方云存储服务的命名规则。accessKey
:String 类型,第三方云存储的 access key。在一般情况下,建议提供只写权限的访问密钥。如需延时转码,则访问密钥必须同时具备读写权限。secretKey
:String 类型,第三方云存储的 secret key。状态码 | 描述 |
---|---|
200 | 请求成功。 |
400 | 参数非法,如 appid 或者 entry_point 为空,或者 region 参数值非法。 |
401 | 未经授权的(客户 ID/客户密钥匹配错误)。 |
404 | 服务器无法根据请求找到资源,即请求的发布点不存在,或者请求的 URI 路径非法。 |
500 | 服务器内部错误,无法完成请求。 |
504 | 服务器内部错误。充当网关或代理的服务器未从远端服务器获取请求。 |