参考信息
本文提供在使用融合 CDN API 过程中,需要额外了解的 API 参考信息。
第三方云存储地区说明
使用自定义录制和自定义截图功能时,你可以通过 StorageConfig
进行录制文件和截图文件的第三方云存储配置,其中 vendor
参数(第三方云存储平台)的取值决定了 region
参数(第三方云存储地区)的取值。
本文介绍 vendor
的不同取值下,region
参数可以配置的值。
- 1
- 2
- 3
- 5
- 6
- 7
- 8
当 vendor
= 1,即第三方云存储为 Amazon S3 时,region
可取如下值:
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_1
当 vendor
= 2,即第三方云存储为阿里云时,region
可取如下值:
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_7
详见阿里云参考文档。
当 vendor
= 3,即第三方云存储为腾讯云时,region
可取如下值:
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_Moscow
当 vendor
= 5,即第三方云存储为 Microsoft Azure 时,无需设置 region
参数,即使设置也不生效。
当 vendor
= 6,即第三方云存储为谷歌云时,无需设置 region
参数,即使设置也不生效。
当 vendor
= 7,即第三方云存储为华为云时,region
可取如下值:
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_1
当 vendor
= 8,即第三方云存储为百度智能云时,region
可取如下值:
1
:Baoding2
:Suzhou3
:Guangzhou4
:Hongkong5
:Singapore6
:Wuhan7
:Shanghai
回源鉴权回调格式
如果你在设置回源鉴权配置的请求中设置了 url
,声网会向这个回调 URL 发送请求,请求中会使用以下参数:
参数 | 类型 | 必选 | 描述 |
---|---|---|---|
host | String | 是 | 推流或者播流域名。 |
entryPoint | String | 是 | 发布点。 |
streamName | String | 是 | 流名称。 |
cdnIp | String | 否 | CDN 节点的 IP 地址。 |
clientIp | String | 否 | 客户端的 IP 地址。 |
token | String | 否 | 鉴权信息。 |
requestId | String | 否 | 请求 ID。 |
你需要按照以下标准返回 HTTP 状态码:
- 200:回源鉴权通过。
- 401:回源鉴权失败。
直播转推回调格式
如果你在设置转推到第三方平台配置的请求中设置了 callbackUrl
,当你向声网推流时,声网会向这个回调 URL 发送请求获取你的推流目标地址。声网发送的请求示例如下:
POST https://example.transfer.com/callback?entry_point={entry_point}&stream_name={stream_name} HTTP/1.1
其中 entry_point
为你的发布点名称,stream_name
为你的直播流名称。
你返回的 HTTP 响应必须满足以下要求:
- 响应内容的格式为 JSON。
- 表示请求成功的 HTTP 状态码为 200。
- 响应包体通过
transferUrls
字段返回目标推流地址,示例如下:JSON{
"transferUrls": [
"rtmp://cdna.example.com/live/testedge",
"rtmp://cdnb.example.com/live/testedge"
]
}
声网成功收到你的 HTTP 响应后,你的直播流将开始转推到第三方平台。
回源拉流回调格式
如果你在设置回源拉流配置的请求中设置了 callbackUrl
,声网会在收到观众的播放请求时,向这个回调 URL 发送请求获取你的源站地址。声网发送的请求示例如下:
GET https://example.origin-site.com/entry_point={entry_point}&stream_name={stream_name} HTTP/1.1
其中以下参数会按播流 URL 中的信息替换:
entry_point
:替换为播流发布点。stream_name
:替换为流名称。
你返回的 HTTP 响应必须满足以下要求:
- 响应内容的格式为 JSON。
- 表示请求成功的 HTTP 状态码为 200。
- 响应包体通过
url
字段返回源站地址,示例如下:JSON{
"url": "rtmp://cdna.example.com/live/testedge"
}