調(diào)用該接口創(chuàng)建一個消費組，用于創(chuàng)建AMQP服務(wù)端訂閱。

限制說明

單個阿里云賬號調(diào)用該接口的每秒請求數(shù)（QPS）最大限制為5。

說明 RAM用戶共享阿里云賬號配額。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 CreateConsumerGroup

系統(tǒng)規(guī)定參數(shù)。取值：CreateConsumerGroup。
GroupName String 是 消費組1

消費組名稱。支持中文漢字、英文字母、數(shù)字和下劃線（_），長度為4~30個字符，一個漢字計為兩個字符。
IotInstanceId String 否 iot-cn-0pp1n8t****

實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面，查看當(dāng)前實例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調(diào)用會失敗。
  • 若無ID值，則無需傳入。

實例的更多信息，請參見實例概述。

調(diào)用API時，除了本文介紹的該API的特有請求參數(shù)，還需傳入公共請求參數(shù)。公共請求參數(shù)說明，請參見公共參數(shù)文檔。

返回數(shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。

ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時，返回的出錯信息。
GroupId String nJRaJPn5U1JITGf******

創(chuàng)建的消費組ID。
RequestId String 73B9DF43-7780-47DE-8BED-077729D28BD2

阿里云為該請求生成的唯一標(biāo)識符。
Success Boolean true

是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateConsumerGroup
&GroupName=消費組1
&<公共請求參數(shù)>

正常返回示例

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
}