3 Telemetry Streamingの管理

この章では、Telemetry Streamingの管理とユーザー管理について説明します。

トピック:

  • 管理の概要
    Telemetry Streamingの様々なタイプのユーザーとその権限について簡単に説明します。
  • ユーザー・ロールおよび権限
    この項では、Telemetry Streamingのユーザー・ロールおよび関連する権限について説明します。
  • ワークスペースの管理
    この項では、Telemetry Streamingでワークスペースを管理する方法について説明します。

3.1 管理の概要

Telemetry Streamingの様々なタイプのユーザーとその権限について簡単に説明します。

Telemetry Streamingでは、既存のデータベース・ユーザーまたはOracle REST Data Services (ORDS)ユーザーを持つことができます。

Telemetry Streamingのデータベース・ユーザーのタイプ

Telemetry Streamingには、その権限と担当に基づいて4つのタイプのデータベース・ユーザーがあります:

  1. TELEMETRY_DBA (Telemetry DBAとも呼ばれます)は、Telemetry Streamingのインストール時に自動的に作成され、Telemetry Streamingインフラストラクチャを所有します。

  2. ワークスペースは、基礎となるスキーマに支えられており、管理性のためにTelemetry Streamingの時系列データを論理的に分離するために使用されます。

  3. ワークスペース管理者は、ワークスペースの管理のためにOracle DBAによって1つ以上のTelemetry Streamingワークスペースに対して指定されるデータベース・ユーザーです。

  4. Telemetry Streamingユーザーは、データベース・ユーザーであり、メトリック・データの取込み、メトリック・データの問合せ、またはその両方のためにワークスペース管理者がワークスペースに割り当てます。

関連項目:

データベース・ユーザーのユーザー・ロールおよび権限の詳細は、「データベース・ユーザーのタイプと権限」を参照してください。

Telemetry StreamingでのORDSユーザーのタイプ

Telemetry Streamingには、権限と担当に基づいて、主に2つのタイプのORDSユーザーがあります:

  1. ワークスペースの管理権限を持つORDS管理者ユーザー

  2. ORDSエンドポイントを使用して、データの取込み、データの問合せまたはその両方を行う権限を持つORDS取込みユーザーまたはORDS問合せユーザー

関連項目:

ORDSユーザーのユーザー・ロールおよび権限の詳細は、「ORDSユーザーのタイプおよび権限」を参照してください。

親トピック: Telemetry Streamingの管理

3.2 ユーザー・ロールと権限

この項では、Telemetry Streamingのユーザー・ロールおよびそれに関連付けられた権限について説明します。

親トピック: Telemetry Streamingの管理

3.2.1 データベース・ユーザーのタイプと権限

次の表は、Telemetry Streamingの設定で各データベース・ユーザー・タイプが果たす様々な役割を示しています。

表3-1 データベース・ユーザーのタイプと担当

ユーザー・タイプ 構成 担当

TELEMETRY_DBA (テレメトリDBAとも呼ばれます)

PDB当たり1つ

Telemetry Streamingをインストールすると、TELEMETRY_DBAというテレメトリDBAユーザーも作成されます。テレメトリDBAは、Telemetry Streamingインフラストラクチャを提供するすべてのPL/SQLパッケージを所有します。

テレメトリDBAは、Telemetry Streamingのインストール・スクリプト($ORACLE_HOME/admin/telemetry_install_plsql.sql)を使用して作成されます。

ワークスペース

PDB当たり多数

ワークスペースは、時系列データを論理的に分離するために使用されます。管理、取込みおよび問合せのために、ユーザーを各ワークスペースに割り当てることができます。

顧客が作成するワークスペースごとに、データのライフサイクル管理のためにデータ、メタデータおよびスケジューラ・ジョブを所有するパスワードなしのデータベース・ユーザー(スキーマ)が作成されます。パスワードなしスキーマの名前は、TM$<workspace name>という形式です。

テレメトリ・ワークスペース管理者(管理ユーザーとも呼ばれます)

ワークスペースごとに多数

DBAロールを持つOracle AI Databaseユーザーは、既存のPDBユーザーを特定のワークスペースの管理者にすることができます。

Oracle DBAは、dbms_telemetry_workspace.enable_workspace_adminプロシージャを呼び出すことで、適切な権限を管理者に割り当てることができます。

ワークスペース管理者は、dbms_telemetry_admin.enable_workspace_userを適切な引数とともに使用して、他の既存のPDBユーザーを取込みユーザーまたは問合せユーザーとして機能するように指定できます。

管理ユーザーは、すべてのワークスペース管理PL/SQLパッケージおよびビューにアクセスできます。

関連項目:

Telemetryワークスペース・ユーザー

ワークスペースごとに多数

既存のPDBユーザーは、ワークスペースとして表される特定の時系列ユース・ケースのユーザーとして有効化されます。

テレメトリ・ワークスペース管理者は、PL/SQL APIを使用して既存のデータベース・ユーザーを有効または無効にできます。特定のワークスペースのテレメトリ・ワークスペース管理者は、dbms_telemetry_admin.enable_workspace_userプロシージャを呼び出して、そのワークスペースで既存のPDBユーザーを有効にします。

これらのユーザーは、データの取込み、データの問合せ、またはその両方に割り当てることができます。PDBユーザーは、一度に1つのワークスペースにのみ取込みユーザーまたは問合せユーザーとして割り当てることができます。

取込みユーザーは取込みパッケージにアクセスでき、問合せユーザーは問合せパッケージおよび問合せユーザー・ビューにアクセスできます。

関連項目:

親トピック: ユーザー・ロールおよび権限

3.2.2 ORDSユーザーのタイプおよび権限

次の表は、Telemetry Streamingの設定で各ORDSユーザー・タイプが果たす様々な役割を示しています。

表3-2 ORDSユーザーのタイプと担当

ユーザー・タイプ 構成 担当

テレメトリORDS管理者(またはORDS管理者)

ワークスペースごとに1つ

DBMS_TELEMETRY_ADMIN.ENABLE_WORKSPACE_ORDSを使用してワークスペースがORDS対応になると、ワークスペースに対してテレメトリORDS管理者が作成されます。

DBMS_TELEMETRY_ADMIN.GET_WORKSPACE_ORDS_ADMIN_AUTHを使用して取得された管理資格証明(クライアントIDとクライアント・シークレット)により、ORDS管理ユーザーは、ORDS取込みユーザーまたは問合せユーザーの追加、ワークスペースのパラメータの表示および操作などのワークスペース管理タスクを実行できます。

テレメトリORDSユーザー(ORDS取込みユーザーおよびORDS問合せユーザー)

ワークスペースごとに多数

ORDS管理者は、関連するRESTエンドポイントを使用して、ORDS取込みユーザーまたは問合せユーザーをワークスペースに追加します。これらのORDSユーザーは、割り当てられたロールに基づいて、OAuth資格証明を使用して、対応する取込みまたは問合せRESTエンドポイントにアクセスできます。この資格証明は、取込み、問合せまたはその両方を行うためにこれらのORDSユーザーの作成時に生成されています。

関連項目:

ORDS管理者およびORDSユーザーの作成方法の詳細は、「ORDSワークスペース・ユーザーの管理」を参照してください。

親トピック: ユーザー・ロールおよび権限

3.3 ワークスペースの管理

この項では、Telemetry Streamingでワークスペースを管理する方法について説明します。

ワークスペースは、データベース・ユーザーとORDSユーザーに対して異なる方法で管理されます。次の項では、データベース・ユーザーおよびORDSユーザーのワークスペースの管理および管理手順について説明します。

データベース・ユーザーのワークスペースの概要

DBMS_TELEMETRY_WORKSPACE PL/SQLパッケージは、ワークスペース関連の操作を処理します。各ワークスペースは、メトリック・データを格納するための排他スキーマによって支えられています。スキーマの名前は、TM$<workspace_name>など、TM$で始まります。Oracle DBAロールを持つユーザーは、ワークスペースを作成または削除でき、ワークスペース管理者を有効または無効にすることもできます。

ワークスペース内には、ワークスペース管理者ロール、問合せユーザー・ロールまたは取込みユーザー・ロールという3つの異なるロールがあります。Oracle DBAは、DBMS_TELEMETRY_WORKSPACE PL/SQLパッケージを使用して次のことができます:

  • ワークスペース管理者としての既存のデータベース・ユーザーの有効化

  • ワークスペース管理者としてのユーザーの無効化

ワークスペース管理者ロールを持つユーザーは、DBMS_TELEMETRY_ADMIN PL/SQLパッケージまたはワークスペース管理REST APIを使用して次のことができます:

  • 既存のデータベース・ユーザーをワークスペースの取込みユーザー、問合せユーザーまたはその両方として有効にします。

  • ワークスペースのユーザーの無効化

  • ワークスペースのパラメータの設定および取得

関連項目:

DBMS_TELEMETRY_WORKSPACEおよびDBMS_TELEMETRY_ADMIN PL/SQLパッケージの詳細は、Oracle AI Database PL/SQLパッケージおよびタイプ・リファレンスのDBMS_TELEMETRY_WORKSPACEおよびDBMS_TELEMETRY_ADMINを参照してください

Oracle DBAは、1つのワークスペースを管理する複数のワークスペース管理者を割り当てたり、複数のワークプレイスを管理する1人のワークスペース管理者を割り当てることができます。ワークスペース・ユーザーに関して、ワークスペース管理者は複数のユーザーを1つのワークスペースに割り当てることができますが、1人のユーザーは1つのワークスペースにのみ割り当てることができます。ユーザーは、そのワークスペースの取込みユーザー、問合せユーザー、またはその両方にすることができます。次の図は、ワークスペースとワークスペース管理者の関係、およびワークスペースとユーザーの関係を示しています。

図3-1 Telemetry Streamingでのワークスペースとユーザーの関係

Telemetry Streamingでのワークスペースとユーザーの関係

ORDSユーザーのワークスペースの概要

ORDSワークスペース・ユーザーの管理およびワークスペース管理のためのREST APIの使用の詳細は、「ORDSワークスペース・ユーザーの管理」および「ワークスペース管理のためのREST APIの使用」を参照してください。

親トピック: Telemetry Streamingの管理

3.3.1 データベース・ワークスペース・ユーザーの管理

この項では、Telemetry Streamingで様々なデータベース・ユーザー・ロールを管理する方法について説明します。

Oracle DBAは、ワークスペースを作成または削除できます。ワークスペースの作成後、Oracle DBAは、ワークスペースの管理者ロールを既存のデータベース・ユーザーに割り当てることができます(このユーザーはワークスペース管理者と呼ばれるユーザーになります)。

DBMS_TELEMETRY_WORKSPACEパッケージを使用すると、Oracle DBAはワークスペースを作成または削除したり、ワークスペースのワークスペース管理者を有効または無効にすることができます。Oracle DBAは、DBMS_TELEMETRY_WORKSPACE.CREATE_WORKSPACE()プロシージャを呼び出してワークスペースを作成し、DBMS_TELEMETRY_WORKSPACE.ENABLE_WORKSPACE_ADMIN()プロシージャを呼び出して適切な権限をワークスペース管理者に割り当てます。

Telemetry Streamingのインストールおよび設定の一環として、Telemetry Streamingのデータベース・ユーザーを管理するために、次の管理手順が使用されます:

ワークスペース管理

Oracle DBA権限を持つユーザーは、次のPL/SQLパッケージを使用してワークスペースを管理できます。

表3-3 DBMS_TELEMETRY_WORKSPACE

プロシージャ/ファンクション 説明

CREATE_WORKSPACE

新しいワークスペースを作成します

DROP_WORKSPACE

ワークスペースを削除します

ENABLE_WORKSPACE_ADMIN

ワークスペースに管理ユーザーを追加します

DISABLE_WORKSPACE_ADMIN

ワークスペースから管理ユーザーを削除します

関連項目:

DBMS_TELEMETRY_WORKSPACE PL/SQLパッケージの詳細は、Oracle AI Database PL/SQLパッケージおよびタイプ・リファレンスのDBMS_TELEMETRY_WORKSPACEを参照してください。

また、Oracle DBAは次のビューにアクセスできます。

表3-4 ワークスペース管理ビュー

ビュー 説明

TELEMETRY_DBA.TELEMETRY_WORKSPACES

PDBで作成されたすべてのTelemetry Streamingワークスペースをリストします

TELEMETRY_DBA.TELEMETRY_ADMINS

PDBに作成されたTelemetry Streamingワークスペースに関連付けられているすべての管理者をリストします

関連項目:

ワークスペース管理ビューの詳細は、「表およびビュー」を参照してください

ワークスペース管理

既存のOracle AI Databaseユーザーをワークスペースの管理者として割り当てることができます。ワークスペース管理者は、取込みまたは問合せのためのユーザーを追加できます。ワークスペース管理者は、ワークスペース・データ・ライフサイクル管理パラメータを変更することもできます。

ワークスペース管理者は、次のPL/SQLパッケージを使用できます。

表3-5 DBMS_TELEMETRY_ADMIN

プロシージャ/ファンクション 説明

ENABLE_WORKSPACE_USER

ワークスペースに既存のデータベース・ユーザーを追加します

DISABLE_WORKSPACE_USER

ワークスペースからユーザーを無効にします

SET_WORKSPACE_PARAMETER

ワークスペース・パラメータを設定します
GET_WORKSPACE_PARAMETER

ワークスペース・パラメータの値を返します

関連項目:

DBMS_TELEMETRY_ADMIN PL/SQLパッケージの詳細は、Oracle AI Database PL/SQLパッケージおよびタイプ・リファレンスのDBMS_TELEMETRY_ADMINを参照してください。

また、ワークスペース管理者は、次のビューにアクセスできます。

表3-6 ワークスペース管理ビュー

ビュー 説明

TELEMETRY_DBA.TELEMETRY_WORKSPACE_USERS

管理ユーザーが管理するすべてのワークスペースに関連付けられているすべてのユーザーをリストします

TM$<workspace name>.TELEMETRY_INGEST_STATS

取込みユーザーによるingest_metricsへのコールごとに1行が含められます

TM$<workspace name>.TELEMETRY_INGEST_DISCARDS

現在の時刻の3600秒前より古い時間のメトリックは破棄され、このビューに記録されます。
TM$<workspace name>.TELEMETRY_QUERY_STATS

問合せユーザーによるdbms_telemetry_queryプロシージャへのコールごとに1行が含められます
TM$<workspace name>.TELEMETRY_ADMIN_LOG

管理アクションに関連するメッセージが含まれています

関連項目:

ワークスペース管理ビューの詳細は、「表およびビュー」を参照してください

親トピック: ワークスペースの管理

3.3.2 ORDSワークスペース・ユーザーの管理

この項では、Telemetry StreamingでORDSワークスペース・ユーザーを管理する方法について説明します。

ORDSワークスペース管理者は、取込みまたは問合せのためにORDSユーザーを追加できます。ユーザーがORDSを介してTelemetry Streamingにデータをプッシュしたり、Telemetry Streamingからデータを問い合せる場合は、ORDS管理ユーザーによって作成された資格証明のOAuthクライアントIDとクライアント・シークレットのペアが必要となります。その後、ユーザーは、OAuthの2レッグ認可メカニズムに従って、ORDSエンドポイントを使用してデータの取込みまたは問合せを行う必要があります。

ワークスペースのORDSを有効にし、ORDSワークスペース管理ユーザーのOAuth資格証明を取得するには、次のPL/SQLパッケージを使用します。

表3-7 DBMS_TELEMETRY_ADMIN

プロシージャ/ファンクション 説明

ENABLE_WORKSPACE_ORDS

このプロシージャは、指定されたワークスペースでORDSを有効にし、Telemetry StreamingのRESTエンドポイントを作成します

GET_WORKSPACE_ORDS_ADMIN_AUTH

このファンクションは、Telemetry Streaming ORDS管理ユーザーのclient-IDおよびcliend-secret OAuth資格証明を返します

ORDSユーザーのTelemetry Streamingワークスペースを設定するには、次の手順に従います。

ワークスペースのORDSを有効にする前に、ワークスペース・スキーマ(TM$WKSP1など)を任意のORDS_DBAから有効にする必要があります。 

exec ORDS.enable_schema(p_enabled => TRUE, p_schema => 'TM$WKSP1', p_url_mapping_type => 'BASE_PATH',
 p_url_mapping_pattern => 'wksp1', p_auto_rest_auth => FALSE);

スキーマがORDS対応になったら、ワークスペース管理者として接続し、次の文を実行する必要があります:

exec dbms_telemetry_admin.enable_workspace_ords('wksp1');

ワークスペースがORDS対応になると、管理ユーザーが作成されます。管理資格証明(クライアントIDおよびクライアント・シークレット)は、次の文を実行して取得できます:

select dbms_telemetry_admin.get_workspace_ords_admin_auth('wksp1');

この設定により、ワークスペースがORDS対応になり、管理者によって認証されたインタフェースの使用の準備が整います。

ワークスペースのORDS管理ユーザーを作成したら、add_userおよびdrop_user RESTエンドポイント(管理クライアントIDとクライアント・シークレットを使用して管理ユーザーがアクセス可能)を使用して、ORDS取込みユーザーまたは問合せユーザーを追加または削除できます。

ユーザーは次のエンドポイントを使用して追加できます:

/ords/<Workspace Name>/add_user

ユーザーの追加に成功すると、APIは新しいユーザーのクライアントIDおよびクライアント・シークレットを返します。

これらの資格証明により、ユーザーは関連するエンドポイントにアクセスできます。たとえば、ワークスペースwksp1の取込みORDSユーザーing1は、次の取込みエンドポイントにアクセスできます: 

/ords/wksp1/ing1/ingest

ユーザーは次のエンドポイントを使用して削除できます:

/ords/<Workspace Name>/drop_user

ノート:

単一のORDSユーザーに取込み権限と問合せ権限の両方を付与できます。

関連項目:

ワークスペース管理APIの詳細は、「ワークスペース管理のためのREST APIの使用」を参照してください

親トピック: ワークスペースの管理

3.3.2.1 ワークスペース管理のためのREST APIの使用

この項では、ワークスペースの管理に使用されるREST APIのドキュメントを示します。

ノート:

  • REST APIを使用する前に、ORDSがインストールされ、Telemetry StreamingがREST対応であることを確認してください。

  • REST APIコールを行うには、認可に使用するOAuth2アクセス・トークンが必要になります。トークンは、PL/SQLインタフェースを使用して、ORDSワークスペース管理者が作成した資格証明のクライアントIDとクライアント・シークレットのペアを指定した後に取得できます。

関連項目:

ORDSインストールの詳細は、「Oracle REST Data Servicesのインストール」を参照してください。

ORDSワークスペース管理REST API

ORDSワークスペース管理APIを使用すると、ORDSワークスペース管理者は、ORDSユーザーの管理、ワークスペース・パラメータの構成と確認、ワークスペース・ログへのアクセスなど、様々な管理タスクを実行できます。新しいORDSユーザーの追加、既存のユーザーの削除、ワークスペースの構成パラメータへのアクセスまたは変更など、管理操作の実行に使用できる管理ORDSエンドポイントがいくつかあります。

これらの管理エンドポイントについては、次のAPIドキュメントで説明します:

表3-8 REST APIのサマリー

APIタイプ 要約

POST /ords/<Workspace Name>/add_user

ワークスペースに取込みユーザーまたは問合せユーザーを追加します

POST /ords/<Workspace Name>/drop_user

ワークスペースから取込みユーザーまたは問合せユーザーを削除します

GET /ords/<Workspace Name>/list_users

ユーザーのリスト(現在のワークスペースのユーザー名およびロール)を取得します。

GET /ords/<Workspace Name>/init_parameters

パラメータをデフォルト値に初期化します

GET /ords/<Workspace Name>/get_parameters

すべてのパラメータとその値を取得します

POST /ords/<Workspace Name>/set_parameter

パラメータに新しい値を設定します

GET /ords/<Workspace Name>/get_parameter/<Parameter Name>

指定したパラメータの値を取得します。

GET /ords/<Workspace Name>/list_log/?from=<start time epoch>&to=<end time epoch>&limit=<number of entries>

指定した期間範囲内のTELEMETRY_ADMIN_LOGの上位データ(limitで指定)をすべてスクレイピングし、collection_feedとして表示します。

GET /ords/<Workspace Name>/show_ingest_stats/?from=<start time epoch>&to=<end time epoch>&limit=<number of entries>

指定した期間範囲内のtelemetry_ingest_statsの上位データ(limitで指定)をすべてスクレイピングし、collection_feedとして表示します

GET /ords/<Workspace Name>/show_query_stats/?from=<start time epoch>&to=<end time epoch>&limit=<number of entries>

指定した期間範囲内のtelemetry_query_statsの上位データ(limitで指定)をすべてスクレイピングし、collection_feedとして表示します
ユーザーの追加

メソッド:

POST

パス:

/ords/<Workspace Name>/add_user

ユーザー:

ワークスペースのORDS管理ユーザー

要約:

ワークスペースに取込みユーザーまたは問合せユーザーを追加します

データ:

{"user_name":<User Name> , "role": <INGEST|QUERY>}

HTTPコード:
  • 201 - 成功しました。clientIdとシークレットが返されます
  • 400 - エラー・メッセージ{"error_code": <code>, "error_message":<message>}で失敗しました
  • 401 - 権限がありません

例:
  • PATH: /ords/workspace1/add_user
  • データ: {"user_name":"INGEST1" , "role": "INGEST"}
  • コード: 201 - 正常に挿入されました
  • {"client_id":"RWRvoD2byhqNdWImmWbelA..","client_secret":"jjkvQPAZbbVTg6iozelk0Q.."}

ノート:

ORDSで取込みロールと問合せロールの両方を持つユーザーを追加するには、「role」に「INGEST|QUERY」または「QUERY|INGEST」を指定します。
ユーザーの削除

メソッド:

POST

パス:

/ords/<Workspace Name>/drop_user

ユーザー:

ワークスペースのORDS管理ユーザー

要約:

ワークスペースからORDS取込みユーザーまたはORDS問合せユーザーを削除します。

データ:

{"user_name":<User Name>}

HTTPコード:
  • 201 - ユーザーが正常に削除されました: <ユーザー名>
  • 400 - エラー・メッセージ{"error_code": <code>, "error_message":<message>}で失敗しました
  • 401 - 権限がありません

例:
  • PATH: /ords/workspace1/drop_user
  • データ: {"user_name":"INGEST1"}
  • コード: 201 - ユーザーが正常に削除されました: INGEST1
ユーザーのリスト

メソッド:

GET

パス:

/ords/<Workspace Name>/list_users

ユーザー:

ワークスペースのORDS管理ユーザー

要約:

現在のワークスペース内のユーザー名、それぞれのロール、およびユーザーのクライアントIDとクライアント・シークレットのリストを取得します

HTTPコード:
  • 200 - 成功しました。データ{[{"user_name": <user>,"role": <role>},...]}が返されます
  • 400 - エラー・メッセージ{"error_code": <code>, "error_message":<message>}で失敗しました
  • 401 - 権限がありません

例:
  • PATH: /ords/workspace1/list_users
  • コード: 200 - 成功しました
{
    "items":[
        {
            "name":"INGEST1",
            "description":"A client for ingest management",
            "client_id":"_sPBlyIrAXpRLn6rRX4-YQ..",
            "client_secret":"C2e33aDKGM0-AowcgPjmmg.."
        },
        {
            "name":"admin_client",
            "description":"default admin client",
            "client_id":"CCpAyUsiCggqZNMrm4l3ZA..",
            "client_secret":"KPQF3kDOCClFanMDCS1Ugg.."
        }
    ],
    "hasMore":false,
    "limit":20,"offset":0,
    "count":2
}
パラメータの初期化

メソッド:

GET

パス:

/ords/<Workspace Name>/init_parameters

ユーザー:

ワークスペースのORDS管理ユーザー

要約:

パラメータをデフォルト値に初期化します

HTTPコード:
  • 200 - パラメータがデフォルト値に初期化されました
  • 400 - エラー・メッセージ{"error_code": <code>, "error_message":<message>}で失敗しました
  • 401 - 権限がありません

例:
  • パス: /ords/workspace1/init_parameters
  • コード: 200 - 成功しました
パラメータの取得

メソッド:

GET

パス:

/ords/<Workspace Name>/get_parameters

ユーザー:

ワークスペースのORDS管理ユーザー

要約:

すべてのパラメータとその値を取得します

HTTPコード:
  • 200 - 成功しました
  • {[{"parameter_name": <name>,"parameter_value": <value>, "parameter_modified_timestamp":<modified date>},...]}
  • 400 - エラー・メッセージ{"error_code": <code>, "error_message":<message>}で失敗しました
  • 401 - 権限がありません

例:
  • パス: /ords/workspace1/get_parameters
  • コード: 200 - 成功しました
{
    "items":[
      {"parameter_name":"delete_after_duration_hours","parameter_value":"240","parameter_modified_timestamp":"2025-07-04T11:17:38.381Z"},
      {"parameter_name":"compress_after_duration_hours","parameter_value":"24","parameter_modified_timestamp":"2025-07-04T11:17:38.392Z"},
      {"parameter_name":"downsample_after_duration_hours","parameter_value":"24","parameter_modified_timestamp":"2025-07-04T11:17:38.398Z"},
      {"parameter_name":"downsample_interval_seconds","parameter_value":"60","parameter_modified_timestamp":"2025-07-04T11:17:38.400Z"},
      {"parameter_name":"downsample_method","parameter_value":"avg","parameter_modified_timestamp":"2025-07-04T11:17:38.404Z"}
    ],
    "hasMore":false,"limit":20,"offset":0,"count":5
}
パラメータ値の設定

メソッド:

POST

パス:

/ords/<Workspace Name>/set_parameter

ユーザー:

ワークスペースのORDS管理ユーザー

要約:

パラメータに新しい値を設定します

データ:

{"parameter_name":<param_name>, "value":<new_value>}

HTTPコード:
  • 201 - 成功しました。パラメータ: param_name値がnew_valueに設定されました
  • 400 - エラー・メッセージ{"error_code": <code>, "error_message":<message>}で失敗しました
  • 401 - 権限がありません

例:
  • パス: /ords/workspace1/set_parameter
  • データ: {"parameter_name":"downsample_interval_seconds", "value":70}
  • コード: 201 - 成功しました
  • {"parameter":"downsample_interval_seconds","value":"70"}
パラメータ値の取得

メソッド:

GET

パス:

/ords/<Workspace Name>/get_parameter/<Parameter Name>

ユーザー:

ワークスペースのORDS管理ユーザー

要約:

指定されたパラメータの値を取得します

HTTPコード:
  • 200 - データが正常に取得されました
  • {"parameter_name": <name>,"parameter_value": <value>, "default":<value>, last_modified: "timestamp"}
  • 400 - エラー・メッセージ{"error_code": <code>, "error_message":<message>}で失敗しました
  • 401 - 権限がありません

例:
  • パス: /ords/workspace1/get_parameter/downsample_interval_seconds
  • コード: 200 - 成功しました
{"parameter_name":"downsample_interval_seconds", "parameter_value":70,
 "default":60, "last_modified":"04-JUL-25 12.00.06.542000 PM"}
管理ログの取得

メソッド:

GET

パス:

/ords/<Workspace Name>/list_log/?from=<start time epoch>&to=<end time epoch>&limit=<number of entries>

ユーザー:

ワークスペースのORDS管理ユーザー

要約:

このAPIは、指定された期間範囲内のTELEMETRY_ADMIN_LOGの上位データ(limitで指定)をすべてスクレイピングし、collection_feedとして表示します。

HTTPコード:
  • 200 - データが正常に取得されました
  • 400 - エラー・メッセージ{"error_code": <code>, "error_message":<message>}で失敗しました
  • 401 - 権限がありません

例:
  • パス: /ords/workspace1/list_log/?from=1704700084&to=1704710884&limit=1
  • コード: 200 - 成功しました
{
   "items":[
       {
           "log_message":"DOWNSAMPLE:Checking Table_flat Done: .040007",
           "log_timestamp":"2025-07-04T12:04:30.173Z"
       }
   ],
   "hasMore":false,"limit":0,"offset":0,"count":1
}
取込みデータの取得

メソッド:

GET

パス:

/ords/<Workspace Name>/show_ingest_stats/?from=<start time epoch>&to=<end time epoch>&limit=<number of entries>

ユーザー:

ORDS取込みユーザー

要約:

このAPIは、指定された期間範囲内のTELEMETRY_INGEST_STATSの上位データ(limitで指定)をすべてスクレイピングし、collection_feedとして表示します

HTTPコード:
  • 200 - データが正常に取得されました
  • 400 - エラー・メッセージ{"error_code": <code>, "error_message":<message>}で失敗しました
  • 401 - 権限がありません

例:
  • パス: /ords/workspace1/show_ingest_stats/?from=1704700084&to=1704710884&limit=100
  • 出力:
{
    "items":[
        {
            "payload_size":559,
            "metrics_ingested":6,
            "metrics_given":6,
            "ingest_user_name":"INGEST1",
            "ingest_duration_milliseconds":1100,
            "ingest_method":"ords",
            "ingest_timestamp":"2025-07-03T09:21:05.236Z"
        }
    ],
    "hasMore":false,
    "limit":0,
    "offset":0,
    "count":2
}
問合せデータの取得

メソッド:

GET

パス:

/ords/<Workspace Name>/show_query_stats/?from=<start time epoch>&to=<end time epoch>&limit=<number of entries>

ユーザー:

ORDS問合せユーザー

要約:

このAPIは、指定された期間範囲内のTELEMETRY_QUERY_STATSの上位データ(limitで指定)をすべてスクレイピングし、collection_feedとして表示します

HTTPコード:
  • 200 - データが正常に取得されました
  • 400 - エラー・メッセージ{"error_code": <code>, "error_message":<message>}で失敗しました
  • 401 - 権限がありません

例:
  • パス: /ords/workspace1/show_query_stats/?from=1751636250&to=1751636258&limit=1
  • 出力:
{
    "items":[
        {
            "query_type":"promql_instant",
            "start_time_epoch":1751636257,
            "end_time_epoch":null,
            "step_size_seconds":null,
            "query_user_name":"QUERYUSER1",
            "query_duration_milliseconds":380,
            "query_method":"ords",
            "query_timestamp":"2025-07-04T13:43:12.590Z"
        }
    ],
    "hasMore":false,"limit":0,"offset":0,"count":1
}