公共参数

网易云基础服务支持 2 中签名方式，所需要的公共参数是不同的，用户可以根据实际情况选择使用哪种签名认证方式。

公共参数（适用于签名 1）

Action

  • 名称：Action
  • 类型：String
  • 必须：是
  • 说明：接口的指令名称，每个接口都对应一个 Action，见具体的接口文档。如：查询云服务器列表接口，其 Action 为 DescribeServers

Version

  • 名称：Version
  • 类型：String
  • 必须：是
  • 说明：API 的版本号，其格式为 yyyy-MM-dd，如 2017-11-16

Region

  • 名称：Region
  • 类型：String
  • 必须：是
  • 说明： SAM 是全局服务，Region 指定为 Global

AccessKey

  • 名称：AccessKey
  • 类型：String
  • 必须：是
  • 说明：访问密钥中的 Access Key ，用于唯一标识一个用户

Timestamp

  • 名称：Timestamp
  • 类型：String
  • 必须：是
  • 说明：客户端请求的时间戳，日期格式按照 ISO8601 标准格式，并需要使用 UTC 时间。格式为： YYYY-MM-DDThh:mm:ssZ。如：2018-01-08T06:20:00 （北京时间:2018 年 1 月 8 日 14 点 20 分 00 秒。需要注意的是，您的请求需要在该时间戳的 15 分钟以内发送到网易云，否则网易云将拒绝该请求。

SignatureVersion

  • 名称：SignatureVersion
  • 类型：String
  • 必须：是
  • 说明：

SignatureMethod

  • 名称：SignatureMethod
  • 类型：String
  • 必须：是
  • 说明：计算签名时 Hmac 的算法，当前只支持 HMAC-SHA256

SignatureNonce

  • 名称：SignatureNonce
  • 类型：String
  • 必须：是
  • 说明：计算签名时 Hmac 的算法，当前只支持 HMAC-SHA256

Signature

  • 名称：Signature
  • 类型：String
  • 必须：是
  • 说明：请求计算出来的签名

DryRun

  • 名称：DryRun
  • 类型：Boolean
  • 必须：否
  • 说明：true/false。使用该参数时，请求只用于校验签名信息是否正确，而不进行实际的处理。当签名正确并且该参数的值为 true 时，返回 DryRunOperation 错误

公共参数（适用于签名2）

Action

  • 名称：Action
  • 类型：String
  • 必须：是
  • 说明：接口的指令名称，每个接口都对应一个 Action，见具体的接口文档。如：查询云服务器列表接口，其 Action 为 DescribeServers。

Version

  • 名称：Version
  • 类型：String
  • 必须：是
  • 说明：API 的版本号，其格式为 yyyy-MM-dd，如 2017-11-16。

X-163-Credential

  • 名称：Version
  • 类型：String
  • 必须：是
  • 说明: 请求的凭证，是由：AK、请求日期、请求资源所在 region 、请求的服务名称、特定字符串（163_request）组成的字符串。格式为 AccessKey/YYYYMMDD/region/serviceName/163_request。

Note

请求日期为 ISO8601 标准， UTC 时间对应的日期，不包含时间，格式为：YYYYMMDD 。 资源所在 region，当前可用值为：cn-east-1、cn-north-1 且 cn-east-1 对应域名 open.cn-east-1.163yun.com。 cn-north-1 对应域名 open.cn-north-1.163yun.com。 若请求时使用的域名与该参数不能对应，则认为请求错误。

X-163-Date

  • 名称：Version
  • 类型：String
  • 必须：是
  • 说明：客户端请求的时间戳，每个请求需使用不同的时间戳。格式按照 ISO8601 标准表示，并需要使用 UTC 时间，格式为：YYYY-MM-DDThh:mm:ssZ。如：2017-09-06T11:00:00Z（北京时间 2017 年 9 月 6 号 19 点 0 分 0 秒）。客户端请求的时间戳与服务端收到请求的时间戳相差绝对值为 15 分钟以内则认为 X-163-Date 参数合法，否则则认为 X-163-Date 参数非法。

Note

X-163-Date 可以提前或落后服务器时间 15 分钟以内，超过 15 分钟则服务器会拒绝掉请求。 若请求中已经包含名为 date 的 header，则可以不使用该参数，默认解析顺序为：先解析 X-163-Date ，若没有，则在继续解析名为 date 的 header

X-163-SignedHeaders

  • 名称：Version
  • 类型：String
  • 必须：是
  • 说明：参与签名计算的 header 的名称列表，不同的 header 名称使用分号分隔。Host header 是必须有的，X-163-Date 与 Date 可以二选一，其余标准 header 是可选的。如：host;content-type;x-163-date。

X-163-SignatureVersion

  • 名称：Version
  • 类型：String
  • 必须：是
  • 说明：签名算法版本 2.0。

X-163-SignatureMethod

  • 名称：Version
  • 类型：String
  • 必须：是
  • 说明：当前只支持 HMAC-SHA256。

X-163-SignatureNonce

  • 名称：Version
  • 类型：String
  • 必须：是
  • 说明：唯一随机数，用于防止网络重放攻击，每个请求使用不同的值,最大长度为64位。

X-163-DryRun

  • 名称：DryRun
  • 类型：Boolean
  • 必须：否
  • 说明：增加该参数可以用于校验签名信息是否正确，不进行实际的处理。若签名校验失败，则返回签名计算中每一步的详细信息，客户端可以根据提示的信息判断出哪一步骤发生了错误从而进行进一步修改。Boolean 类型。

X-163-Signature

  • 名称：Signature
  • 类型：String
  • 必须：是
  • 说明：计算得到的签名信息