所有接口请求中都必须携带公共参数,为了避免重复说明,产品的API文档中可能不再重复描述这部分参数,请您在请求API时携带这部分参数,否则请求将无法通过合法性验证。
注:Action和Version必须放在query当中
名称 | 类型 | 是否必填 | 参数格式 | 描述 |
---|---|---|---|---|
Action | String | 是 | [a-zA-Z]+ | 接口名称。 |
Version | String | 是 | YYYY-MM-DD | 接口的版本。 |
X-Expires | Int | 否 | 300 | 签名的有效时间,单位为秒,不填时默认值为900。 |
注:签名参数可以在query中,也可以在header中。
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-Date | String | 是 | 使用UTC时间,精确到秒,例如: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中的信息含义:
名称 | 类型 | 备注 |
---|---|---|
AccessKeyId | String | 请求的Access Key ID。 |
ShortDate | String | 请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD ,例如:20180201 |
Region | String | 请求的Region,例如:cn-north-1 |
Service | String | 请求的服务,例如:iam |
SignedHeaders | String | 参与签名的Header,用分号分隔。 |
Signature | String | 计算完毕的签名。 |
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-Date | String | 是 | 使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z |
X-Algorithm | String | 是 | 固定值:HMAC-SHA256 |
X-Credential | String | 是 | 由{AccessKeyId}/{ShortDate}/{Region}/{Service}/request 组成。 |
X-SignedHeaders | String | 是 | 参与签名的Header,用分号分隔。 |
X-Signature | String | 是 | 计算完毕的签名。 |