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

Dataphin:カスタムメッセージチャンネルでサポートされるメタデータ

最終更新日:Nov 20, 2025

このトピックでは、カスタムメッセージチャネルでサポートされるメタデータについて説明します。

前提条件

メッセージチャネルを設定する必要があります。詳細については、「メッセージチャネル」をご参照ください。

背景情報

  • カスタムメッセージチャンネル API は、基本的なメタデータを提供します。Proxy アプリケーションは、この情報を使用してアラートメッセージをスペックアップし、アラートコンテンツをアセンブルします。

    image

  • API のメタデータが要件を満たさない場合は、OpenAPI を使用して詳細情報を取得できます。

    image

共通メタデータ

パラメーター名

データ型

説明

receiver_phone

String

メッセージ受信者の電話番号。例: 1361234****。

receiver_name

String

メッセージ受信者のユーザー名。例: SuperAdmin。

receiver_userid

String

Dataphin システム内のメッセージ受信者の内部ユーザー ID。これは Dataphin システム内の一意の ID です。例: 1234567。

receiver_sourceuserid

String

ソースシステムからのメッセージ受信者の ID。この ID は、RAM、ASCM、またはシングルサインオン (SSO) ソフトウェア開発キット (SDK) に基づく顧客独自の認証システムなど、統合認証システムに関連しています。例: username@dataphin。

receiver_email

String

受信者のメールアドレス。例: username@***.com。

receiver_message

String

受信者が Dataphin システムから受信する事前定義されたメッセージ。例: ノード ods_order が失敗したため、アラートがトリガーされました。このノードは ods_dataphin プロジェクトに属しています。

message_type

String

サポートされているメッセージタイプ。有効な値:

  • LOGICAL_INSTANCE_ALARM: 未生成インスタンスのアラート。

  • BATCH_PROCESS_ALARM: オフラインタスクのアラート。

  • REALTIME_PROCESS_ALARM: リアルタイムタスクのアラート。

  • STREAM_PIPELINE_ALARM: リアルタイム統合タスクのアラート。

  • BASELINE_ALARM: ベースラインのアラート。

  • DATA_QUALITY_ALARM: Data Quality のアラート。

  • DATA_SERVICE_ALARM: DataService Studio のアラート。

  • PERMISSION_NOTICE: 権限通知。

  • TENANT_NOTICE: テナント通知。

message_metadata

JSON

JSON リゾルバーを使用してデータを表示できます。

生成されないインスタンスのアラート (LOGICAL_INSTANCE_ALARM)

パラメーター名

データ型

説明

event_id

String

アラートのイベント ID。

reason

String

アラートの理由:

LOGICAL_INSTANCE_GENERATION: 論理インスタンス生成のモニタリング。

オフラインタスクのアラート (BATCH_PROCESS_ALARM)

パラメーター名

データ型

説明

event_id

String

アラートのイベント ID。

reason

String

アラートの理由:

  • VDM_BATCH_ERROR: ノードが失敗しました。

  • VDM_BATCH_FINISH: ノードは完了です。

  • VDM_BATCH_TIME_OUT: ノードがタイムアウトしました。

  • VDM_BATCH_UNDONE: ノードが完了していません。

instance_id

String

アラートをトリガーしたタスクインスタンスの ID。

instance_url

String

アラート インスタンスの URL です。

bizdate

String

タスクインスタンスのデータタイムスタンプ。これは、日次、週次、月次のスケジューリングに適用されます。時間単位のノードもデータタイムスタンプのみをサポートします。

node_id

String

タスク ID

node_name

String

タスク名。

project_id

String

ノードが属するプロジェクトの ID。

project_name

String

ノードが属するプロジェクトの名前。

node_owner

String

タスクオーナー

notify_time

String

アラートがトリガーされた時刻です。

monitor_owner

String

モニタリングルールを作成したユーザー。

cur_value

Number

ノードの実行時間。このパラメーターは、タイムアウト監視タイプにのみ使用されます。

threshold

List<String>

  • タイムアウト: ノードの最大予想実行時間。

  • 未完了: 予想完了時刻。

receivers

String

アラート受信者に関する情報。フォーマット: 受信者表示名 1 (受信者ログオンアカウント関連 ID 1)、受信者表示名 2 (受信者ログオンアカウント関連 ID 2)。

due_time

String

インスタンスのスケジュールされた実行時間。このパラメーターは、定期タスクでのみサポートされます。

execute_start_time

String

インスタンスの実行が開始された時刻。失敗後に自動的にリトライされるインスタンスの場合、このパラメーターは最新のリトライの開始時刻を示します。

instance_log_url

String

アラートインスタンスの実行ログの URL。

folder

String

ノードが属するフォルダ。フォーマットは /FolderName/ です。ノードがルートディレクトリにある場合、値は / です。

description

String

タスクの説明。

リアルタイムタスクのアラート (REALTIME_PROCESS_ALARM)

パラメータ名

データ型

説明

event_id

String

アラートのイベント ID。

reason

String

アラートの理由:

  • STREAM_BIZ_DELAY: ビジネスレイテンシーが高すぎます。

  • STREAM_DATA_RETENTION: データが設定された期間より長く保持されています。

  • STREAM_MORE_THAN_FAILURE: 失敗頻度が設定値を超えています。

  • STREAM_TPS_OUT_RANGE: 1 秒あたりのトランザクション数 (TPS) が指定された範囲外です。

  • STREAM_CHECKPOINT_FAILURE: チェックポイントの失敗回数が設定値を超えています。

  • STREAM_BACKPRESSURE: バックプレッシャーの期間が設定値を超えています。

alert_period

String

メトリックの検出頻度 (秒単位)。

threshold

List<Number>

アラートに設定されているしきい値。値はアラートの理由によって異なります。

  • 高いビジネスレイテンシー: (値)、秒単位。

  • 範囲外の TPS: (min,max)。

  • 失敗率が設定値を超える: (値)。

  • データが設定期間より長く保持される: (値)、秒単位。

  • チェックポイントの失敗が設定値を超える: (値)。

condition

String

判断条件。有効な値:

  • great than: より大きい。

  • between: 間 (値 1 以上、値 2 以下)。

cur_value

String

現在の値です。

instance_url

String

アラートインスタンスの URL です。

node_name

String

ジョブ名

project_id

String

ノードが属するプロジェクトの ID。

project_name

String

ノードが属するプロジェクトの名前。

node_owner

String

タスクのオーナー。

notify_time

String

アラートがトリガーされた時刻です。

monitor_owner

String

モニタリングルールを作成したユーザー。

receivers

String

アラート受信者に関する情報。フォーマット: 受信者表示名 1 (受信者ログオンアカウント関連 ID 1)、受信者表示名 2 (受信者ログオンアカウント関連 ID 2)。

リアルタイム統合タスクのアラート (STREAM_PIPELINE_ALARM)

パラメータ名

データ型

説明

event_id

String

アラートのイベント ID。

reason

String

アラートの理由:

  • STREAM_BIZ_DELAY: ビジネスレイテンシーが高すぎます。

  • STREAM_MORE_THAN_FAILURE: 失敗頻度が設定値を超えています。

alert_period

String

メトリックの検出頻度 (秒単位)。

threshold

List<Number>

アラートに設定されているしきい値。値はアラートの理由によって異なります。

  • 高いビジネスレイテンシー: (値)、秒単位。

  • 失敗率が設定値を超える: (値)。

condition

String

判断条件。gt: より大きい。

cur_value

String

現在の値。

instance_url

String

アラートインスタンスの URL です。

node_name

String

ジョブ名。

project_id

String

ノードが属するプロジェクトの ID。

project_name

String

ノードが属するプロジェクトの名前。

node_owner

String

タスクのオーナー

receivers

String

アラート受信者に関する情報。フォーマット: 受信者表示名 1 (受信者ログオンアカウント関連 ID 1)、受信者表示名 2 (受信者ログオンアカウント関連 ID 2)。

ベースラインのアラート (BASELINE_ALARM)

パラメーター名

データ型

説明

events

List(Event)

ベースラインアラートのアラートイベント。

receivers

String

アラート受信者に関する情報。フォーマット: 受信者表示名 1 (受信者ログオンアカウント関連 ID 1)、受信者表示名 2 (受信者ログオンアカウント関連 ID 2)。

イベント

アラートがマージされる場合、各アラートメッセージは個別のイベントになります。それ以外の場合、メッセージには単一のイベントのみが含まれます。

パラメーター名

データ型

説明

event_id

String

アラートのイベント ID。

reason

String

アラートの理由:

  • KGB_TASK_ERROR: ベースライン ノードが失敗しました。

  • KGB_TASK_SLOW_DOWN: ベースライン ノードが低速になりました。

  • KGB_EARLY_WARNING: ベースラインの早期警告。

  • KGB_BROKEN_LINE: ベースラインが中断されました。

baseline_instance_id

String

アラートをトリガーしたベースライン インスタンスの ID。

baseline_instance_url

String

アラートをトリガーしたベースライン インスタンスの URL。

baseline_bizdate

String

ベースライン インスタンスのデータタイムスタンプ (日次または週次スケジューリングの場合) またはビジネス時間 (時間または分ベースのスケジューリングの場合)。

baseline_id

String

ベースライン ID。

baseline_name

String

ベースライン名。

baseline_owner

String

ベースラインのオーナー。

node_instance_id

String

アラートをトリガーしたタスクインスタンスの ID。このパラメーターは、ベースラインイベントアラート (ベースラインノードが失敗した場合、またはベースラインノードが遅延した場合) にのみ提供されます。

node_instance_url

String

アラートをトリガーしたタスクインスタンスの URL。このパラメーターは、ベースラインイベントアラート (ベースラインノードが失敗した場合、またはベースラインノードが遅延した場合) にのみ提供されます。

node_id

String

アラートをトリガーしたノードの ID。 このパラメーターは、ベースライン イベント アラート (ベースライン ノードが失敗した場合、またはベースライン ノードが低速になった場合) にのみ提供されます。

node_name

String

アラートをトリガーしたノードの名前。 このパラメーターは、ベースライン イベント アラート (ベースライン ノードが失敗した場合、またはベースライン ノードが低速になった場合) にのみ提供されます。

project_id

String

アラートをトリガーしたノードが属するプロジェクトの ID。 このパラメーターは、ベースライン イベント アラート (ベースライン ノードが失敗した場合、またはベースライン ノードが低速になった場合) にのみ提供されます。

project_name

String

アラートをトリガーしたノードが属するプロジェクトの名前。 このパラメーターは、ベースライン イベント アラート (ベースライン ノードが失敗した場合、またはベースライン ノードが低速になった場合) にのみ提供されます。

node_owner

String

アラートをトリガーしたノードのオーナー。 このパラメーターは、ベースライン イベント アラート (ベースライン ノードが失敗した場合、またはベースライン ノードが低速になった場合) にのみ提供されます。

baseline_priority

String

ベースラインの優先度。

baseline_allowance

String

ベースラインのマージン。

current_key_node_instance_id

String

現在ベースラインアラートを引き起こしているタスクインスタンスの ID。このパラメーターは、ベースラインアラート (ベースライン早期警告または中断されたベースライン) にのみ提供されます。

current_key_node_name

String

現在ベースライン アラートを発生させているノードの名前。 このパラメーターは、ベースライン アラート (ベースラインの早期警告またはベースラインの中断) にのみ提供されます。

current_key_node_id

String

現在ベースライン アラートを発生させているノードの ID。 このパラメーターは、ベースライン アラート (ベースラインの早期警告またはベースラインの中断) にのみ提供されます。

current_key_node_owner

String

現在ベースライン アラートを発生させているノードのオーナー。 このパラメーターは、ベースライン アラート (ベースラインの早期警告またはベースラインの中断) にのみ提供されます。

current_key_node_project_name

String

現在ベースライン アラートを発生させているノードが属するプロジェクトの名前。 このパラメーターは、ベースライン アラート (ベースラインの早期警告またはベースラインの中断) にのみ提供されます。

current_key_node_instance_url

String

現在ベースラインアラートを引き起こしているタスクインスタンスの URL。このパラメーターは、ベースラインアラート (ベースライン早期警告または中断されたベースライン) にのみ提供されます。

baseline_num

Number

影響を受けるベースラインの数。

Data Quality のアラート (DATA_QUALITY_ALARM)

パラメータ名

データ型

説明

event_id

String

アラートのイベント ID。

reason

String

アラートの理由:

  • DQE_COLUMN: フィールドルールで例外が発生しました。

  • DQE_DATA_SOURCE: データソースルールで例外が発生しました。

  • DQE_CUSTOMIZE: カスタムルールで例外が発生しました。

  • DQE_TABLE: テーブルルールで例外が発生しました。

  • DQE_REALTIME_TABLE: ストリーミングテーブルルールで例外が発生しました。

  • DQE_INDEX: メトリックルールで例外が発生しました。

object_id

String

アラートをトリガーしたオブジェクト。フォーマット:

  • Dataphin 論理テーブル: BusinessCategoryName.LogicalTableName。

  • Dataphin 物理テーブル: ProjectName.TableName。

  • Dataphin リアルタイムメタテーブル: ProjectName.TableName。

  • グローバルデータテーブル: DataSourceName.db/schema.tablename。

  • メトリック: BusinessCategoryName.LogicalTableName.MetricName。

  • データソース - 接続性: データソース ID。

  • データソース - テーブルスキーマの変更: DataSourceName.db/schema.tablename。

rule_name

String

ルールの名前。

rule_level

String

ルールの強度。

rule_type

String

テンプレートの名前。

notify_time

String

アラートがトリガーされた時刻。

project_name

String

プロジェクトの名前。

detail_object_id

String

監視対象の詳細オブジェクト:

  • フィールドルールの例外: フィールドの名前。

  • データソースルールの例外: テーブルの名前。

receivers

String

アラート受信者に関する情報。フォーマット: 受信者表示名 1 (受信者ログオンアカウント関連 ID 1)、受信者表示名 2 (受信者ログオンアカウント関連 ID 2)。

quality_index

String

品質チェックの設定値と実績値。たとえば、チェック構成が '正常行 >= 100 かつ例外率 < 10%' で、実績メトリックが '正常行 = 100 かつ例外行 = 11%' の場合です。

例: チェック構成: '正常行 >= 100 かつ例外率 < 10%'。実績メトリック: '正常行 = 100 かつ例外行 = 11%'。

quality_index_kv

String

ルールチェックの主要なメトリック。例: 合計行数: 100、正常行数: 80、異常行数: 20、正常率: 80%、異常率: 20%。

例: 合計行数: 100; 正常行数: 80; 異常行数: 20; 正常率: 80%; 異常率: 20%。

他のタイプは、チェック値と比較値として表示されます。例: パーティション数: 100; 7 日前のパーティション数: 100。

説明

設定された主要なメトリックのみが表示されます。中間データは表示されません。

DataService Studio のアラート (DATA_SERVICE_ALARM)

パラメータ名

データ型

説明

event_id

String

アラートのイベント ID。

reason

String

アラートの理由:

  • OS_AVG_RESPONSE: 平均応答時間が異常です。

  • OS_CALL_TIMES: 呼び出し回数が異常です。

  • OS_ERROR_RATE: エラー率が異常です。

  • OS_OFFLINE: オフラインの割合が異常です。

api_id

String

API ID です。

api_name

String

API 名です。

statistical_period

String

モニタリングメトリックの統計期間 (秒単位)。

alert_period

String

メトリックの検出頻度 (秒単位)。

threshold

List<Number>

アラートに設定されているしきい値。値はアラートの理由によって異なります。

  • 呼び出し回数: 値。

  • エラー率: 値。

  • 平均応答時間: 値 (秒単位)。

condition

String

判断条件。有効な値:

  • great than: より大きい。

  • between: 間。

  • less than: より小さい。

  • great than equal: 以上。

  • less than equal: 以下。

  • equal: 等しい。

cur_value

String

現在の値。

receivers

String

アラート受信者に関する情報。フォーマット: 受信者表示名 1 (受信者ログオンアカウント関連 ID 1)、受信者表示名 2 (受信者ログオンアカウント関連 ID 2)。