更新消費者分組的基礎信息和消費重試策略。
接口說明
注意 阿里云提供的 OpenAPI 屬于管控類 API，用于管理和查詢阿里云服務的相關資源。僅推薦在管控鏈路集成，消息收發的核心數據鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| rocketmq:UpdateConsumerGroup | update | *ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId} |
| 無 |
請求語法
PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId} HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 待更新消費者分組所屬的實例的 ID。 | rmq-cn-7e22on9**** |
| consumerGroupId | string | 是 | 待更新的消費者分組 ID。 | CID-TEST |
| body | object | 否 | 請求體。 | |
| remark | string | 否 | 更新后的消費者分組的備注信息。 | This is the remark for test. |
| deliveryOrderType | string | 是 | 更新后的消費者分組的投遞順序性。 參數取值如下：
| Concurrently |
| consumeRetryPolicy | object | 是 | 更新后的消費者分組的消費重試策略。更多信息，請參見 消費重試。 | |
| retryPolicy | string | 是 | DefaultRetryPolicy | |
| maxRetryTimes | integer | 否 | 最大重試次數。 | 16 |
| deadLetterTargetTopic | string | 否 | 死信 Topic。 消費者出現異常消費某條消息失敗，且消息重試后依然未成功，消息將被投遞至死信 Topic 中，以便后續進行業務恢復或回溯。更多信息，請參見消費重試與死信。 | DLQ_mqtest |
返回參數
示例
正常返回示例
JSON格式
{
"requestId": "C7F94090-3358-506A-97DC-34BC803C****",
"success": true,
"data": true,
"code": "InvalidDeliveryOrderType",
"message": "Parameter deliveryOrderType is invalid.",
"httpStatusCode": 400,
"dynamicCode": "DeliveryOrderType",
"dynamicMessage": "deliveryOrderType"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2022-11-17 | API 內部配置變更，不影響調用 | 查看變更詳情 |