文档中心 云直播 公共参数

公共参数

更新时间:2022-04-28 18:15:00

公共参数是用于标识用户和接口鉴权目的的参数,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。推荐使用接口鉴权v3。

接口鉴权v2

该鉴权方式需要在请求头部设置以下两个属性。在两个属性都设置的情况下,该鉴权方式优先于接口鉴权v1。使用接口鉴权v2,接口鉴权v1的3个请求参数无需设值。

参数名 类型 是否必填 描述
x-access-token string 必填 凭证。用于判断是否具有API权限。
x-api-version string 必填 API版本,当前版本是1.0。

x-access-token的获取与鉴权方式详细说明见《网宿云视频-鉴权接口说明文档》。

接口鉴权v3

该鉴权方式需要在请求头部设置以下3个属性。在3个属性都设置的情况下,鉴权时会使用该鉴权方式鉴权。优先级:接口鉴权v3>接口鉴权v2>接口鉴权v1。使用接口鉴权v3,其他两种鉴权方式的公共参数无须设值。

  参数名                                     类型 是否必填 描述
X-WS-AccessKey string       是       访问密钥ID。对于的SecretKey通过平台的密钥管理获得。主账号和子账号都具有不同的ID。服务端会对其授权范围进行校验,账号只能操作其有权限操作的数据。
X-WS-Timestamp string 操作的时间戳,单位是秒
Authorization int 授权信息
content-Type string 向服务器实际发送的数据类型。
host string 请求域名

该鉴权方式参数的获取与鉴权方式详细说明见 接口鉴权v3

返回参数格式

返回json格式的返回结果。

参数名 类型 是否必填 描述
format string 返回结果格式为json格式
本篇文档内容对您是否有帮助?
有帮助
没帮助
提交成功!非常感谢您的反馈,我们会继续努力做到更好!