使用须知
更新时间:2024-04-18
API调用遵循HTTP协议,采用REST风格。服务域名为 lss.bj.baidubce.com。 数据交换格式为JSON,所有request/response body内容均采用UTF-8编码。
如果您刚刚接触LSS产品,请参阅LSS产品描述进行详细了解。
注意:“域名” 分为推流域名和直播域名,分别cname至LSS所生成的地址。用户往推流域名上推流, 即可在直播域名上进行播放。
API认证机制
所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成,均为字符串。 对于每个HTTP请求,使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}
。
- version是正整数。
- timestamp是生成签名时的UTC时间。
- expirationPeriodInSeconds表示签名有效期限。
- signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号(;)分隔,如host;x-bce-date。列表按照字典序排列。(本API签名仅使用host和x-bce-date两个header)
- signature是256位签名的十六进制表示,由64个小写字母组成。
当百度智能云接收到用户的请求后,系统将使用相同的SK和同样的认证机制生成认证字符串,并与用户请求中包含的认证字符串进行比对。如果认证字符串相同,系统认为用户拥有指定的操作权限,并执行相关操作;如果认证字符串不同,系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见鉴权认证。
AK/SK的获取方法请参见获取AK/SK
LSS服务域名
- LSS 的服务域名是
lss.bj.baidubce.com
。 - LSS API支持HTTP和HTTPS两种协议。为了提升数据的安全性,建议使用HTTPS协议。
日期与时间规范
日期与时间的表示有多种方式。为统一起见,除非约定俗成或有相应规范,凡是HTTP标准中规定的表示日期和时间字段用GMT,其他日期时间表示的地方一律采用UTC时间,遵循ISO 8601,并做以下约束:
- 表示日期一律采用
YYYY-MM-DD
方式,例如2016-07-07
表示2016年7月7日。 - 表示时间一律采用
hh:mm:ss
方式,并在最后加一个大写字母Z表示UTC时间。例如23:00:10Z
表示UTC时间23点0分10秒。 - 凡涉及日期和时间合并表示时,在两者中间加大写字母T,例如
2016-07-07T23:00:10Z
表示UTC时间2016年7月7日23点0分10秒。
API版本号
参数 | 类型 | 参数位置 | 描述 | 是否必须 |
---|---|---|---|---|
version | String | URL参数 | API版本号,不同的接口的版本号有所不同,请以具体接口文档中的请求示例中的版本号为准。 | 是 |
- 排版约定
排版格式 | 含义 |
---|---|
< > | 变量 |
[ ] | 可选项 |
{ } | 必选项 |
¦ | 互斥关系 |
等宽字体Courier New | 屏幕输出 |