すべてのプロダクト
Search
ドキュメントセンター

:ConsumerGroupHeartBeat

最終更新日:Nov 07, 2025

コンシューマーは、アクティブなステータスを維持するために、サーバーにハートビートを送信します。

操作説明

API の説明

  • Host は、プロジェクト名と Simple Log Service エンドポイントで構成されます。Host にはプロジェクトを指定する必要があります。

  • コンシューマーは、接続を維持するために、固定間隔でサーバーにハートビートを送信します。サーバーが指定された期間内にコンシューマーからハートビートを受信しない場合、そのコンシューマーは削除されます。

  • AccessKey ペアを取得します。詳細については、「AccessKey ペア」をご参照ください。

Alibaba Cloud アカウントの AccessKey ペアは、すべての API 操作に対する権限を持っています。これは高いセキュリティ脅威をもたらします。API 操作の呼び出しや定期的な O&M の実行には、RAM ユーザーを作成して使用することを推奨します。RAM ユーザーは、Simple Log Service リソースを管理する権限を持っている必要があります。詳細については、「RAM ユーザーの作成と権限付与」をご参照ください。

  • プロジェクト名、リージョン、および Logstore 名を取得します。詳細については、「プロジェクトの管理」および「Logstore の管理」をご参照ください。

  • 使用者グループ名を取得します。詳細については、「ListConsumerGroup」をご参照ください。

権限付与情報

次の表に、この操作の権限付与情報を示します。この情報を RAM ポリシーの Action 要素に追加して、RAM ユーザーまたは RAM ロールにこの API 操作を呼び出す権限を付与します。

操作権限付与ポリシーのリソース
log:ConsumerGroupHeartBeatacs:log:${regionId}:${accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/{#ConsumerGroupName}

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

log:ConsumerGroupHeartBeat

none

*All Resource

*

  • log:TLSVersion
なし

リクエスト構文

POST /logstores/{logstore}/consumergroups/{consumerGroup}?type=heartbeat HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

logstore

string

必須

Logstore の名前。

ali-test-logstore

consumerGroup

string

必須

使用者グループの名前。名前はプロジェクト内で一意である必要があります。

consumer_group_test

リクエストパラメーター

パラメーター

必須 / 任意

説明

project

string

必須

プロジェクトの名前。

ali-test-project

consumer

string

必須

コンシューマー。

consumer_1

body

array

必須

消費されているシャード ID のリスト。

integer

任意

消費されているシャード ID のリスト。

[0]

レスポンスフィールド

フィールド

説明

array

コンシューマーによって消費されるすべてのシャード ID のリスト。

integer

コンシューマーによって消費されるすべてのシャード ID のリスト。

[0]

成功レスポンス

JSONJSON

[
  0
]

エラーコード

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

変更履歴

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