所有接口请求中都必须携带公共参数,为了避免重复说明,产品的 API 文档中可能不再重复描述这部分参数,请您在请求 API 时携带这部分参数,否则请求将无法通过合法性验证。
说明
Action和Version必须放在query当中。
名称 | 类型 | 是否必填 | 参数格式 | 描述 | 示例值 |
|---|---|---|---|---|---|
Action | String | 是 | [a-zA-Z]+ | 接口名称。实际调用时请参考您使用的产品的API文档取值。 | CreateUser |
Version | String | 是 | YYYY-MM-DD | 接口的版本。 实际调用时请参考您使用的产品的API文档取值。 | 2018-01-01 |
X-Expires | Int | 否 | 整数 | 签名的有效时间,单位为秒,不填时默认值为900。 | 900 |
说明
签名参数可以在 query 中,也可以在 header 中。
名称 | 类型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
X-Date | String | 是 | 使用UTC时间,精确到秒,使用遵循ISO 8601标准的格式: |
|
Authorization | String | 是 |
|
|
X-Security-Token | String | 否 | 指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的SessionToken,使用长期密钥时无需填写该参数。 |
|
Authorization 中的信息含义:
名称 | 类型 | 备注 | 示例值 |
|---|---|---|---|
AccessKeyId | String | 请求的 Access Key ID。 |
|
ShortDate | String | 请求的短时间,使用 UTC 时间,精确到日。请使用格式: |
|
Region | String | 请求的地域,例如: |
|
Service | String | 请求的服务名,例如: |
|
SignedHeaders | String | 参与签名的Header,多个Header间用分号分隔,目的是指明哪些header参与签名计算,从而忽略请求被proxy添加的额外header,其中host、x-date如果存在header中则必选参与。 |
|
Signature | String | 计算完毕的签名。详细说明请参考签名方法 |
|
名称 | 类型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
X-Date | String | 是 | 使用UTC时间,精确到秒。 |
|
X-Algorithm | String | 是 | 固定值: |
|
X-Credential | String | 是 | 由 |
|
X-SignedHeaders | String | 是 | 参与签名的Header,多个Header间用分号分隔,目的是指明哪些header参与签名计算,从而忽略请求被proxy添加的额外header,其中host、x-date如果存在header中则必选。 |
|
X-Signature | String | 是 | 计算完毕的签名。详细说明请参考签名方法。 |
|