CDN加速

公共参数

更新时间:2021-07-30 15:36:01

目录

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

请求公共参数(接口鉴权v3)

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

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

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

指定返回参数格式

可以返回json或xml格式的返回结果。
默认返回json格式数据,如需要返回xml格式,则在请求参数里带上format参数。对于get请求,将参数放到url参数串中;
对于post请求,则将其与其他非公共参数放在body中。

参数名 类型 是否必填 描述
format string 返回结果格式,可选值json或xml,默认为json

返回公共参数

Response header中返回服务端生成唯一请求标识

参数名 类型 描述
X-WS-RequestId string 请求唯一标识,用于方便问题排查

例如:
Response Headers
X-WS-RequestId: 3728d44912a711e4348190e221012d52

对于所有的API接口,返回的body数据如下格式的内容(以json数据格式为例):

l 成功时返回:

参数名 类型 描述
code int 错误码;200,表示请求成功
message string 请求成功
data obj 请求成功时返回的数据,如果请求失败,该字段为空

例如:

{
​     "code": 200,
​     "message": "操作成功",
​     "data": {
​         "taskId": "b123456789012345678912",
​         "transNo": "a123456789012345678912"
​     }
}

l 失败时返回:

参数名 类型 描述
code int 请求失败错误响应码
message string 请求失败提示信息

例如:

{
  "code": 1000,
  "message": "参数错误"
}