You need to enable JavaScript to run this app.
导航
公共参数
最近更新时间:2023.12.12 20:59:47首次发布时间:2023.12.08 15:01:59

公共参数是每个接口都需要使用的请求参数,开发者每次使用火山引擎 API 发送请求时都需要携带这些公共请求参数,否则会导致请求失败。

请求参数

在发起请求时,需要包含两类参数:公共请求参数和接口特有的请求参数。

公共请求参数

在发起所有 OpenAPI 请求时,请求中必须包含以下公共参数:

名称类型取值位置说明
Hoststringrtc.volcengineapi.comheader服务地址
Content-Typestring/header资源的 MIME 类型。
  • Post 请求中,该值为 application/json
  • Get 请求中,该值可为空。
X-Datestring/header请求时间,UTC 时间,形如20201230T081805Z
X-Content-Sha256string/header对请求体采用 SHA256 加密后的结果字符串。
Authorizationstring/header签名。关于如何获得这一签名,参看对 OpenAPI 请求进行签名
Actionstring/Query String接口名称。参看接口详情文档。
Versionstring/Query String接口版本。参看接口详情文档。

对于接口特有请求参数,参看具体 OpenAPI 接口文档。