文档

公共参数

更新时间:

调用网盘与相册服务 PDS 的 API 时需要提供多个请求头参数,调用 API 后 PDS 会有返回值。本文为您介绍调用 PDS API 时所需的公共请求头和返回的公共参数。


公共请求参数

公共请求参数是指每个接口都需要使用到的请求参数,根据认证方式的不同,公共头有所不同,见下方说明。

AccessKey 与 AccessToken 区别

  • AccessKey(AK): 主要适用于通过阿里云 AccessKey 进行签名认证来调用 PDS API 的场景。这种方式适合于后端服务器之间的交互,确保了安全性。
  • AccessToken: 更适用于前端应用直接调用 PDS API 的情况,只需要在请求头的 Authorization 字段中携带 AccessToken。

使用阿里云 AccessKey 签名认证时的公共请求头

名称类型是否必须描述
AuthorizationString用于验证请求合法性的认证信息,采用acs AccessKeyId:signature格式
Content-LengthlongRFC 2616中定义的 HTTP 请求内容长度。
Content-TypeStringRFC 2616中定义的 HTTP 请求内容长度。
Content-MD5StringHTTP 协议消息体的 128-bit MD5 散列值转换成 BASE64 编码的结果。为了防止所有请求被篡改,建议所有请求都附加该信息。
DateString描述请求时间。GMT 格式,例如:Wed, 26 Aug. 2015 17:01:00 GMT
AcceptString客户端需要的返回值类型,只支持 application/json
HostString访问域名
x-acs-signature-nonceString唯一随机数,用于防止网络重放攻击。用户在不同请求中要使用不同的随机数值。
x-acs-signature-methodString签名方法,目前只支持HMAC-SHA1
x-acs-signature-versionString签名版本,目前是 1.0。

使用临时访问令牌 AccessToken 认证时的公共请求头

名称类型是否必须描述
HostString访问域名。
AuthorizationString用于验证请求合法性的认证信息,采用Bearer {AccessToken}格式。其中{AccessToken}是指访问令牌,请根据实际情况替换。

公共返回参数

用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId 给用户。 返回示例如下:

{
    "RequestId": "5B467B38-5110-337D-99BA-33149166F546",
    /* 返回结果数据 */
}