调用该接口创建一个消费组,用于创建AMQP服务端订阅。
限制说明
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。
说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateConsumerGroup |
系统规定参数。取值:CreateConsumerGroup。 |
GroupName | String | 是 | 消费组1 |
消费组名称。支持中文汉字、英文字母、数字和下划线(_),长度为4~30个字符,一个汉字计为两个字符。 |
IotInstanceId | String | 否 | iot-cn-0pp1n8t**** |
实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 注意
实例的更多信息,请参见实例概述。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException |
调用失败时,返回的错误码。更多信息,请参见错误码。 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
GroupId | String | nJRaJPn5U1JITGf****** |
创建的消费组ID。 |
RequestId | String | 73B9DF43-7780-47DE-8BED-077729D28BD2 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
是否调用成功。
|
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=CreateConsumerGroup
&GroupName=消费组1
&<公共请求参数>
正常返回示例
XML
格式
<CreateConsumerGroupResponse>
<GroupId>nJRaJPn5U1JITGf******</GroupId>
<RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
<Success>true</Success>
</CreateConsumerGroupResponse>
JSON
格式
{
"GroupId": "nJRaJPn5U1JITGf******",
"RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
"Success": true
}