公共参数分为公告请求参数和公共返回参数和。

公共请求参数

以下公共请求参数适用于通过 URL 发送 POST 请求调用消息队列 for Apache Kafka 的 API。

名称 类型 是否必需 描述
Action String API 的名称。取值请参见接入指南
AccessKeyId String 访问密钥 ID。AccessKey(包含 AccessKeyId 和 AccessKeySecret)用于调用 API,而用户密码用于登录消息队列 for Apache Kafka 控制台
Signature String 您的签名。取值请参见签名机制
SignatureMethod String 签名方式。取值范围:HMAC-SHA1。
SignatureVersion String 签名算法版本。取值范围:1.0。
SignatureNonce String 签名唯一随机数。用于防止网络重放攻击,建议您每一次请求都使用不同的随机数。
Timestamp String 请求的时间戳。按照 ISO8601 标准表示,并需要使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。示例:2018-01-01T12:00:00Z 表示北京时间 2018 年 1 月 1 日 20 点 00 分 00 秒。
Version String API 的版本号,格式为 YYYY-MM-DD。取值范围:2018-10-15。
Format String 返回参数的语言类型。取值范围:json 或 xml。默认值:xml。

请求示例

https:/alikafka.cn-hangzhou.aliyuncs.com/?Action=XXXXXX
&Format=xml
&Version=2014-05-26
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2018-01-01T12:00:00Z
…
			

公共返回参数

名称 类型 描述
RequestId String 请求 ID。无论调用接口成功与否,我们都会返回请求 ID。