You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
合作与生态
支持与服务
开发者
了解我们
导航

公共参数

更新时间:2022.11.28 14:04:40

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

Action&Version

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

名称类型是否必填参数格式描述
ActionString[a-zA-Z]+API名字,与具体的接口相关,表示要执行的操作。
VersionStringYYYY-MM-DDAPI版本信息,当前版本为:2022-10-12。
X-ExpiresInt300签名的有效时间,单位为秒,不填时默认值为900。
x-app-idsint12345应用ID。

签名参数

说明:签名参数可以在Query中,也可以在Header中。

在Header中的场景

名称类型是否必填描述
X-DateString使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z',例如:20201103T104027Z

Authorization

String

HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}
X-Security-TokenString指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken,使用长期密钥时无需填写该参数。

Authorization中的信息含义如下:

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

在Query中的场景

名称类型是否必填描述
X-DateString使用UTC时间,精确到秒,例如:20201103T104027Z
X-AlgorithmString当前固定为:HMAC-SHA256
X-CredentialString{AccessKeyId}/{ShortDate}/{Region}/{Service}/request组成。
X-SignedHeadersString参与签名的Header,多个用分号隔开。
X-SignatureString计算完毕的签名,签名计算方式见签名机制