すべてのプロダクト
Search

このプロダクト

    :UpdateConsumerGroup

    ドキュメントセンター

    :UpdateConsumerGroup

    最終更新日:Jan 16, 2026

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

    操作説明

    重要 Alibaba Cloud OpenAPI は管理 API です。Alibaba Cloud サービスリソースの管理とクエリに使用できます。この API は管理目的のみを対象としています。メッセージの送受信を行うコアデータリンクにはこの API を使用しないでください。データリンクに潜在的な脅威をもたらす可能性があります。

    今すぐお試しください

    この 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

    *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 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

    任意

    固定リトライ間隔。単位：秒。このパラメーターは、retryPolicy パラメーターを FixedRetryPolicy に設定した場合にのみ有効です。 有効値：

    • 同時配信：10～1800

    • 順序配信：1～600

    10
    maxReceiveTps

    integer

    任意

    メッセージ消費の最大 TPS (Transactions Per Second)。

    1000

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Result<boolean>

    requestId

    string

    リクエスト ID。各リクエストには一意の ID があります。この ID を使用して問題のトラブルシューティングを行うことができます。

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

    boolean

    リクエストが成功したかどうかを示します。

    true
    data

    boolean

    返された結果。

    true
    code

    string

    エラーコード。

    InvalidDeliveryOrderType
    message

    string

    エラーメッセージ。

    Parameter deliveryOrderType is invalid.
    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"
}

    エラーコード

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

    変更履歴

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