公共参数
更新时间:2022-12-07
公共请求参数,是指调用任意API时都需要使用到的请求参数,即您每次使用火山引擎Open API发送请求时,都需要携带这些公共请求参数,否则会导致请求失败。
公共请求参数首字母均为大写,以此区分其他请求参数。
操作&版本#
Action和Version必须放在Query当中。
名称 | 类型 | 是否必填 | 参数格式 | 描述 |
---|---|---|---|---|
行动 | 字符串 | 是 | [A-z-Z]+ | API名字,与具体的接口相关,表示要执行的操作。 |
版本 | 字符串 | 是 | 年-月-日 | API版本信息,取值为:2020-04-01。 |
X-过期 | 整数 | 否 | 300 | 签名的有效时间,单位:秒,不填默认900。 |
签名参数#
签名参数是请求必不可少的部分,可以在Header或Query中。
签名参数在Header中的场景#
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X 日期 | 字符串 | 是 | 使用UTC时间,精确到秒,如:20201103T104027Z。 |
授权 | 字符串 | 是 | HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}。 |
Authorization中的信息含义如下:
名称 | 类型 | 备注 |
---|---|---|
访问密钥 | 字符串 | 请求的访问密钥信息。 |
短日期 | 字符串 | 请求的短时间,精确到日。使用UTC时间,如:20180201。 |
地区 | 字符串 | 请求的Region,例如:华北2(北京):cn-beijing。更多Region信息,请参见地域和可用区。 |
服务 | 字符串 | 请求的服务,调用私有网络API时为:vpc。 |
签名标题 | 字符串 | 参与签名的Header,多个用分号隔开。 |
签名 | 字符串 | 计算完毕的签名,签名计算方式见签名机制。 |
签名参数在Query中的场景#
X-Date与Authorization的信息可以直接存在Query当中。
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X 日期 | 字符串 | 是 | 使用UTC时间,精确到秒,如20201103T104027Z。 |
X-算法 | 字符串 | 是 | 当前固定为:HMAC-SHA256。为将来扩展做准备。 |
X-凭据 | 字符串 | 是 | 由{AccessKey}/{ShortDate}/{Region}/{Service}/request组成。 |
X 签名的头像 | 字符串 | 是 | 参与签名的Header,多个用分号隔开。 |
X 签名 | 字符串 | 是 | 计算完毕的签名,签名计算方式见签名机制。 |