公共请求参数是每个接口都需要使用的请求参数,开发者每次使用火山引擎 OpenAPI 发送请求时都需要携带这些公共请求参数,否则会导致请求失败。公共请求参数首字母均为大写,以此区分其他请求参数。
注意
Action 和 Version 必须放在 Query 当中。例如?Action=CreaeFunctiont&Version=2024-06-06
。
名称 | 类型 | 是否必填 | 参数格式 | 描述 |
---|---|---|---|---|
Action | String | 是 | [a-zA-Z]+ | 接口的名字,与具体的接口相关。 |
Version | String | 是 | YYYY-MM-DD | 接口的版本信息,与具体的接口相关。目前仅支持2024-06-06 。 |
说明
签名参数是请求必不可少的部分,可以放在 Header 或 Query 中。
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-Date | String | 是 | 使用 UTC 时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z 。 |
Authorization | String | 是 | 用于验证请求合法性的认证信息。格式为:HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature} 。 |
Authorization 中的信息含义:
名称 | 类型 | 备注 |
---|---|---|
AccessKey | String | 请求的 Access Key ID。 |
ShortDate | String | 请求的短时间,精确到日。使用 UTC 时间,例如:20180201 。 |
Region | String | 请求的地域(Region),例如:cn-beijing ,表示华北2(北京)地域。更多 Region 信息,请参见 开服地域。 |
Service | String | 请求的服务,调用函数服务 API 时为:vefaas 。 |
SignedHeaders | String | 参与签名的 Header,用分号(;)分隔。 |
Signature | String | 计算完毕的签名。签名计算方式,请参见 签名机制。 |
X-Date 与 Authorization 的信息可以直接存在于 Query 当中。
默认 CPU 请求 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-Date | String | 是 | 使用 UTC 时间,精确到秒,例如:20201103T104027Z 。 |
X-Algorithm | String | 是 | 固定值HMAC-SHA256 ;为将来扩展做准备 |
X-Credential | String | 是 | 由{AccessKey}/{ShortDate}/{Region}/{Service}/request 组成。 |
X-SignedHeaders | String | 是 | 参与签名的 Header,用分号(;)分隔。 |
X-Signature | String | 是 | 计算完毕的签名。签名计算方式,请参见 签名机制。 |