/policyengine/v1/policies/<policy_name>/status:GET

ポリシー状況を取得します。

status エンドポイントは、特定のポリシーのポリシー状況情報を取得します。

応答には、以下の情報が含まれます。
  • 合計カウント
  • 完了カウント
  • 失敗数
  • 実行依頼されたカウント
  • Start_Time
  • End_Time

返される応答は、考えられる 3 つのポリシー・シナリオによって異なります。 これには、「実行しない」、「実行中」、「終了」が含まれます。 ポリシーが実行されない (「実行しない」) 場合、応答はポリシー状況のみを返します。

ポリシーが実行中の場合、前のリストに示されているカウントには現行値が含まれ、終了時刻は返されません。

ポリシーが終了すると、カウントには最終値が含まれ、終了時刻が返されます。

以下の表に、REST API エンドポイントにアクセスできるロールを示します。
表 1. 役割によるアクセス
データ管理者 データ・ユーザー コレクション管理者 コレクション・ユーザー 管理者 サービス・ユーザー
✓ 1✓ 1✓ ✓ Χ Χ
1 「コレクション管理者」 役割を持つユーザーは、ポリシーの所有者であるか、ポリシーに含まれている 1 つ以上のコレクションにアクセスできる場合にのみ、このエンドポイントにアクセスできます。

「データ・ユーザー」 役割を持つユーザーは、ポリシーの所有者である場合にのみ、エンドポイントにアクセスできます。

リクエストの概要 URL

curl -k -H 'Authorization: Bearer <token>' https://<data_cataloging_host>/policyengine/v1/ policies/<policy_name>/status -X GET -H ’Accept: application/json’

サポートされる要求タイプと応答形式

サポートされる要求タイプ:
  • GET
サポートされる応答形式:
  • JSON

examples

以下の例では、特定のポリシーに関するポリシー状況情報を戻します。

以下の要求を 1 行で発行します。

curl -k -H 'Authorization: Bearer <token>' https://<data_cataloging_host> /policyengine/v1/policies/policy1/status -X GET -H ’Accept: application/json’
以下の応答が返されます。
{
    "status": "running",
    "total_count": 15000,
    "completed_count": 14000,
    "failed_count": 0,
    "submitted_count": 15000,
    "start_time": "2020-03-27_11:12:10"
}