logologo
售前咨询
直播云
产品简介
产品定价
控制台操作指南
客户端SDK
服务端API
域名管理相关接口
证书管理相关接口
直播流管理相关接口
转码管理相关接口
录制管理相关接口
用量查询相关接口
直播质量相关接口
直播回调相关接口
地址管理相关接口
相关协议
文档中心服务端API公共参数

公共参数


公共请求参数是指所有接口都需要使用的参数,需要 Header 和 Query 两部分内容 。

Header 参数

参数名称 类型 必选 描述
X-SL-Action String 操作的接口名称
取值参考接口文档中输入参数公共参数 Action 的说明。
例如直播云拉取上传接口,取值为 :FetchUpload。
X-SL-Region String 地域参数
用来标识希望操作哪个地域的数据,一般不需要传递该参数,除非接口文档有特殊说明。
X-SL-Version String API版本号
日期形式:YYYY-MM-DD,当前版本对应为2021-11-09。
X-SL-Timestamp String 请求的时间戳,精确到秒。
日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。
例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。
Authorization String HTTP 标准身份认证头部字段
例如:HMAC-SHA256 Credential={AccessKey}/{Date}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature} 其中,HMAC-SHA256:签名方法,目前固定取该值; Credential:AccessKey为密钥ID;Date为UTC标准时间,取值与公共参数 X-SL-Timestamp一致;Region为地域参数,取值与公共参数X-SL-Region一致;Service为产品名,如直播为vod,RTC为rtc;SignedHeaders:参与签名计算的头部信息,用分号分隔,content-type 和 host 为必选头部;Signature:签名摘要,计算过程详见 签名方法。
X-SL-SecurityToken String STS临时授权的Token,默认为空。
AccessKey String 密钥
X-SL-Program-Language String 标识调用来源SDK的编程语言(e.g Java Python Php)

Query 参数

参数名称 类型 必选 描述
Action String 操作的接口名称。
取值参考接口文档中输入参数公共参数 Action 的说明。
例如直播云拉取上传接口,取值为 :FetchUpload。

示例

假设用户想要查询某个视频的媒资信息,接口参数设置为视频媒资ID MediaId=aa2e88a7e95db9f7,则其请求结构按照请求 URL、请求头部、请求体示例如下,

HTTP POST (application/json) 请求结构示例:

https://vod.streamlakeapi.com/?Action=DescribeMediaInfo

AccessKey: xxxx
Authorization: SL-HMAC-SHA256 Credential=1020729fbf374c76b34ae921af762800/2022-08-01/vod/sl_request, SignedHeaders=content-type;host, Signature=5a64d95d24487a547297f2b0bc4b2f848a2875a18aad79254146eeca8059f29bsl_request
Content-Type: application/json
Host: vod.streamlakeapi.com
SignatureVersion: 1
X-SL-Action: DescribeMediaInfo
X-SL-Program-Language: Java
X-SL-Region: beijing
X-SL-Timestamp: 1659320624
X-SL-Version: 2022-06-23
Content-Length: 30
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.13 (Java/18.0.1.1)
Accept-Encoding: gzip,deflate

{"MediaId":"aa2e88a7e95db9f7"}

HTTP GET 请求结构示例:

https://vod.streamlakeapi.com/?Action=DescribeMediaInfo&MediaId=aa2e88a7e95db9f7

AccessKey: xxxx
Authorization: SL-HMAC-SHA256 Credential=1020729fbf374c76b34ae921af762800/2022-08-01/vod/sl_request, SignedHeaders=content-type;host, Signature=5a64d95d24487a547297f2b0bc4b2f848a2875a18aad79254146eeca8059f29bsl_request
Content-Type: application/x-www-form-urlencoded
Host: vod.streamlakeapi.com
SignatureVersion: 1
X-SL-Action: DescribeMediaInfo
X-SL-Program-Language: Java
X-SL-Region: beijing
X-SL-Timestamp: 1659320624
X-SL-Version: 2022-06-23
Content-Length: 190
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.13 (Java/18.0.1.1)
Accept-Encoding: gzip,deflate
上一篇:请求结构下一篇:签名方法
该篇文档内容是否对您有帮助?
有帮助没帮助