文档中心

公共参数

最近更新时间：2023.07.03 14:20:16

首次发布时间：2022.11.25 11:53:32

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

Action&Version

说明：Action和Version必须放在Query当中。

名称	类型	是否必填	参数格式	描述
Action	String	是	[a-zA-Z]+	API名字，与具体的接口相关，表示要执行的操作。
Version	String	是	YYYY-MM-DD	API版本信息，当前版本为：2022-10-12。
X-Expires	Int	否	300	签名的有效时间，单位为秒，不填时默认值为900。
x-app-ids	int	是	12345	应用ID。

名称	类型	是否必填	参数格式	描述
x-app-ids	int	是	12345	应用ID。

说明：签名参数可以在Query中，也可以在Header中。

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'`，例如：`20201103T104027Z`。
Authorization	String	是	`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

Authorization中的信息含义如下：

名称	类型	备注
AccessKey	String	请求的AccessKey信息。
ShortDate	String	请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`。
Region	String	请求的Region，例如：`cn-beijing`。
ServiceName	String	请求的服务，调用服务端API时为apmplus_server，调用其他API时为apmplus_openapi。
SignedHeaders	String	参与签名的Header，多个用分号隔开。
Signature	String	计算完毕的签名，签名计算方式见签名机制。
X-TT-Logid	String	请求ID，生成算法请保持一致性。

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒，例如：`20201103T104027Z`。
X-Algorithm	String	是	当前固定为：`HMAC-SHA256`。
X-Credential	String	是	由`{AccessKeyId}/{ShortDate}/{Region}/{Service}/request`组成。
X-SignedHeaders	String	是	参与签名的Header，多个用分号隔开。
X-Signature	String	是	计算完毕的签名，签名计算方式见签名机制。

Action&Version

Header

签名参数

在Header中的场景

在Query中的场景