すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:UpdateConsumerGroup

    ドキュメントセンター

    ApsaraMQ for RocketMQ:UpdateConsumerGroup

    最終更新日:Sep 24, 2026

    コンシューマーグループの基本情報と消費リトライポリシーを更新します。

    操作説明

    重要 Alibaba Cloud が提供する OpenAPI は、Alibaba Cloud サービスのリソースを管理およびクエリするための管理コントロール API です。管理コントロールリンクでの統合にのみ使用することを推奨します。メッセージの送受信を行うコアデータリンクで OpenAPI を使用しないでください。使用すると、データリンクにリスクが発生する可能性があります。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    rocketmq:UpdateConsumerGroup

    update

    *コンシューマーグループ。

    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

    任意

    更新後のコンシューマーグループの備考。

    テスト用の備考
    deliveryOrderType deprecated

    string

    任意

    変更はサポートされていません。

    列挙値:

    • Concurrently :

      同時配信。

    • Orderly :

      順序配信。

    Concurrently
    consumeRetryPolicy

    object

    必須

    更新後のコンシューマーグループの消費リトライポリシー。詳細については、「消費リトライ」を参照してください。

    retryPolicy

    string

    必須

    リトライポリシータイプ。メッセージ消費時のエラー処理に関する詳細については、「メッセージリトライ」を参照してください。

    有効な値:

    • FixedRetryPolicy: 固定間隔リトライ。順序配信のみサポートされます。

    • DefaultRetryPolicy: 増分バックオフリトライ。同時配信のみサポートされます。

    列挙値:

    • FixedRetryPolicy :

      固定間隔リトライ。

    • DefaultRetryPolicy :

      増分バックオフリトライ。

    DefaultRetryPolicy (デフォルトのエラーリトライポリシー)
    maxRetryTimes

    integer

    任意

    リトライの最大回数。

    16
    deadLetterTargetTopic

    string

    任意

    死信 Topic。

    コンシューマーがメッセージの消費に失敗し、リトライ後も引き続き失敗した場合、メッセージは死信 Topic に配信され、後続のビジネス復旧または確認に使用されます。詳細については、「消費リトライと死信メッセージ」を参照してください。

    DLQ_mqtest
    fixedIntervalRetryTime

    integer

    任意

    固定リトライ間隔。単位: 秒。このパラメーターは、リトライポリシーが FixedRetryPolicy (固定間隔リトライ) に設定されている場合にのみ効果があります。 有効な値:

    • 同時配信: 10-1800

    • 順序配信: 1-600

    10
    maxReceiveTps

    integer

    任意

    メッセージ消費の TPS の上限値。

    1000

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    結果<ブール値>。

    requestId

    string

    リクエスト ID。各リクエストには固有の ID があり、トラブルシューティングと問題の特定に使用できます。

    C7F94090-3358-506A-97DC-34BC803C****
    success

    boolean

    実行が成功したかどうかを示します。

    true
    data

    boolean

    返される結果。

    true
    code

    string

    エラーコード。

    InvalidDeliveryOrderType (有効な値ではありません)
    message

    string

    エラーメッセージ。

    パラメーター deliveryOrderType が有効ではありません。
    httpStatusCode

    integer

    HTTP 状態コード。

    400
    dynamicCode

    string

    動的エラーコード。

    DeliveryOrderType
    dynamicMessage

    string

    動的エラーメッセージ。

    deliveryOrderType

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "C7F94090-3358-506A-97DC-34BC803C****",
  "success": true,
  "data": true,
  "code": "InvalidDeliveryOrderType",
  "message": "Parameter deliveryOrderType is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "DeliveryOrderType",
  "dynamicMessage": "deliveryOrderType"
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。