公共参数--消息队列 Kafka版-火山引擎

文档中心

消息队列 Kafka版

如何调用 API

公共参数

公共参数

本文介绍每个接口都需要使用的请求参数和返回参数。

请求URL参数

参数	类型	是否必选	含义
Action	String	必选	要执行的操作，如调用 DescribeInstances 查询已创建的消息队列 Kafka版实例。
Version	String	必选	要使用的 API 版本，消息队列 Kafka版的 API 版本是 `2018-01-01`。
X-Expires	Integer	可选	签名的有效时间，单位为秒，默认值为 900。

请求头参数

参数	类型	是否必选	含义
Content-Type	String	必选	指定了请求消息体的结构化格式，消息队列 Kafka版的 Content-Type 固定为 `application/json`。
Host	String	必选	即服务地址 endpoint。消息队列 Kafka版的服务地址固定为 `kafka.volcengineapi.com`。接入时，消息队列 Kafka版默认根据用户所在的地域就近访问。同时，您也可以在 `Authorization` 中指定地域进行访问。
X-Date	String	必选	这是您发出请求的日期和时间。在请求中指定日期有助于防止第三方拦截您的请求并稍后重新提交。该日期使用 ISO8601 Basic 格式，通过 X-Date 标头以 YYYYMMDD'T'HHMMSS'Z' 格式指定。
Authorization	String	必选	HTTP 标准身份认证头部字段。格式为 `HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`。

Authorization 字段说明如下。

参数	类型	是否必选	含义
AccessKeyId	String	必选	访问服务使用的密钥 ID，即 Access Key ID。
ShortDate	String	必选	请求服务时的 UTC 短时间，精确到日。格式为 `YYYYMMDD`，例如 `20180201`。
Region	String	必选	访问的服务地域 ID，例如 `cn-beijing`。消息队列 Kafka版支持的地域列表请查看服务地址。
Service	String	必选	访问的服务名称，消息队列 Kafka版服务名称为 `kafka`。
SignedHeaders	String	必选	参与签名的 Header，用分号分隔。例如 `x-date`。
Signature	String	必选	计算完毕的签名结果字符串。如何计算签名，请参考签名方式。

最近更新时间：2022.10.18 16:24:26

这个页面对您有帮助吗？

有用

有用

无用

无用