文档中心

公共参数

最近更新时间：2023.02.15 19:04:53

首次发布时间：2023.02.15 19:04:53

公共参数是每个接口都需要使用的请求参数，开发者每次使用 OpenAPI 发送请求时都需要携带这些公共请求参数，否则会导致请求失败。公共请求参数首字母均为大写，以此区分接口请求参数。

1.Action&Version

说明

Action和Version必须放在Query当中。

名称	类型	是否必填	描述	示例
Action	String	是	接口名称，具体业务侧。接口格式为 `[a-zA-Z]+`	CreateSparrow
Version	String	是	接口版本信息，以具体业务接口说明为准。格式为 `YYYY-MM-DD`	2021-04-30

签名参数是请求必不可少的部分，可以放在Header或Query中：

名称	类型	是否必填	描述	示例
X-Date	String	是	使用UTC时间，精确到秒。	20201103T104027Z
Authorization	String	是	签名值	见下文说明

Authorization内容如下：

HMAC-SHA256 Credential = {AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

{}内的各字段对应信息如下：

名称	类型	是否必填	描述	示例
X-Date	String	是	使用UTC时间，精确到秒	20201103T104027Z
X-Algorithm	String	是	固定值	HMAC-SHA256
X-Credential	String	是	{AccessKey}/{ShortDate}/{Region}/{Service}/request	详情参考签名机制
X-SignedHeaders	String	是	参与签名的Header，用分号分隔	详情参考签名机制
X-Signature	String	是	计算完毕的签名	详情参考签名机制

1.Action&Version

2.签名参数