使用AMQP服務端訂閱時,可以調用該接口修改消費組名稱。

使用說明

不支持修改物聯網平臺提供的默認消費組。

QPS限制

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

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

調試

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

請求參數

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

系統規定參數。取值:UpdateConsumerGroup。

GroupId String nJRaJPn5U1JITGf******

消費組ID。調用CreateConsumerGroup創建消費組成功后,會返回消費組ID。您可以調用QueryConsumerGroupList按消費組名稱查詢消費組ID。

NewGroupName String 消費組2

消費組的新名稱。支持中文漢字、英文字母、數字和下劃線(_),長度為4~30個字符,一個漢字計為兩個字符。

IotInstanceId String iot-cn-0pp1n8t****

實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無實例概覽頁面或ID值,則無需傳入。

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

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔

返回數據

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

調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。

ErrorMessage String 系統異常

調用失敗時,返回的出錯信息。

RequestId String 73B9DF43-7780-47DE-8BED-077729D28BD2

阿里云為該請求生成的唯一標識符。

Success Boolean true

是否調用成功。

  • true:調用成功。
  • false:調用失敗。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateConsumerGroup
&GroupId=nJRaJPn5U1JITGf******
&NewGroupName=消費組2
&<公共請求參數>

正常返回示例

XML格式

<UpdateConsumerGroupResponse>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</UpdateConsumerGroupResponse>

JSON格式

{
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}