本文介绍了在调用 API 时,必须要传递的公共参数。公共参数一般为 OpenAPI 版本和鉴权等信息,在具体的 API 接口文档中不再重复描述这部分参数,请您在请求 API 时携带这部分参数,否则请求将无法通过合法性验证。
签名参数可以在 Query 中也可以在 Header 中,但 Action 和 Version 必须在 Query 中。
参数 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
Action | String | 是 | 接口名称。与实际业务的接口名称一致。 |
|
Version | String | 是 | 接口的版本。Web 应用防火墙提供的 OpenAPI 版本为 |
|
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
X-Expires | Integer | 否 | 签名的有效时间,单位为秒,不填时默认值为 900。 |
X-Date | String | 是 | 使用 UTC 时间,精确到秒。格式为 YYYYMMDD'T'HHMMSS'Z' ,例如: |
Authorization | String | 是 |
|
X-Security-Token | String | 否 | 指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的 SessionToken,使用长期密钥时无需填写该参数。 |
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
X-Expires | Integer | 否 | 签名的有效时间,单位为秒,不填时默认值为 900。 |
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 | 是 | 计算后的签名。 |