You need to enable JavaScript to run this app.
导航

公共参数

最近更新时间2023.02.10 20:00:02

首次发布时间2023.02.10 20:00:02

所有接口请求中都必须携带公共参数,为了避免重复说明,产品的API文档中可能不再重复描述这部分参数,请您在请求API时携带这部分参数,否则请求将无法通过合法性验证。

公共参数如下表

1. Action与Version

注:Action和Version必须放在query当中

名称类型是否必填参数格式描述
ActionString[a-zA-Z]+接口名称。
VersionStringYYYY-MM-DD接口的版本。
X-ExpiresInt300签名的有效时间,单位为秒,不填时默认值为900。

2. 签名参数

注:签名参数可以在query中,也可以在header中。

(1)在Header中的场景

名称类型是否必填描述
X-DateString使用UTC时间,精确到秒,例如:20201103T104027Z
AuthorizationStringHMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}
X-Security-TokenString指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken,使用长期密钥时无需填写该参数。

Authorization中的信息含义:

名称类型备注
AccessKeyIdString请求的Access Key ID。
ShortDateString请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20180201
RegionString请求的Region,例如:cn-north-1
ServiceString请求的服务,例如:iam
SignedHeadersString参与签名的Header,用分号分隔。
SignatureString计算完毕的签名。

(2)在Query中的场景

名称类型是否必填描述
X-DateString使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z
X-AlgorithmString固定值:HMAC-SHA256
X-CredentialString{AccessKeyId}/{ShortDate}/{Region}/{Service}/request组成。
X-SignedHeadersString参与签名的Header,用分号分隔。
X-SignatureString计算完毕的签名。