コンテンツにスキップ

一覧表示



GET /api/v1/blacklist/list

概要

現在のワークスペースのブラックリストルール、有効/無効状態、完全なマッチング設定をページングして照会します。

呼び出し前の準備と使用手順

type=logging でログを、type=all で全体を照会し、名前で検索した後にページごとに読み取ります。未削除のルールには有効と無効が含まれ、最終更新日時(未更新の場合は作成日時)の降順で並びます。一覧は元の filters と実際の conditions を返します。ルールの作成/変更前に、これに基づいて完全な設定を復元できます。

これはブラックリストルール設定 API であり、履歴データ削除 API ではありません。保存時のレスポンスはルールレコードの処理完了を示すだけで、下流の収集/処理パイプラインにおける反映状況や通知結果は提供しません。本番適用前に管理されたサンプルで実際のフィルタ範囲を確認し、ソース/条件を指定しない広範囲なルールを避けてください。このグループの宣言では、無料プランのワークスペースが制限されています。この機能をサポートするワークスペースと、対応する API Key の権限を使用する必要があります。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証資格情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
pageIndex integer 任意、デフォルト 1、最小 1。
null を許可: False
$minValue: 1
例: 1
取得または入力方法: 1 から開始し、トップレベルの pageInfo に従って続行します。
pageSize integer 任意、デフォルト 20、最小 1、現在の宣言に最大値はありません。ページごとに読み取ることを推奨します。
null を許可: False
$minValue: 1
例: 20
取得または入力方法: クライアントの容量に応じて正の整数を選択します。
search string 任意。名前の部分一致のみで、先頭と末尾の空白を除去します。ソースや説明では検索しません。
null を許可: False
例: 健康チェック
取得または入力方法: ルール名のキーワード。
type string Y 必須の文字列。all は特殊な照会値であり、新規ルールのタイプではありません。不明なカテゴリは通常、空のリストで成功します。
null を許可: False
例: logging
取得または入力方法: ログルールには logging を指定し、すべてのカテゴリを管理する場合は all を指定します。対象データカテゴリで正確にフィルタすることもできます。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/blacklist/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode type=logging \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=20

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。

フィールド 型 説明
content.data array<object> このページの未削除ルール。結果が空の場合は []。
content.data[].id integer または null レコード番号。新規項目の作成/インポート時は永続化前のスナップショットのため null になる可能性があり、uuid で操作します。
content.data[].uuid string blist_ ルール UUID。
content.data[].workspaceUUID string 所属ワークスペース UUID。
content.data[].name string ルール名。
content.data[].desc string ルール説明。
content.data[].type string データカテゴリ。
content.data[].source string 保存された単一または全ソースの表現。空の場合があります。
content.data[].sources array<string> 保存された複数のソース名。空でない場合は優先されます。
content.data[].sources[] string 単一のソース名。
content.data[].filters array<object> または object または null 元の条件配列。履歴レコードでは {} または null の場合もあります。
content.data[].filters[].name string リーフフィールド名または履歴グループのプレースホルダー名。
content.data[].filters[].condition string 同じ階層の連結子。
content.data[].filters[].operation string 演算子。履歴項目では op が使用され、省略される場合があります。
content.data[].filters[].op string 履歴の演算子エイリアス。省略可能。
content.data[].filters[].value JSON 保存された値または値配列。
content.data[].filters[].value[] JSON 単一の元の値。
content.data[].filters[].filters array<object> ネストされた条件グループ。省略可能。同じ条件構造を再帰的に持ちます。
content.data[].conditions string フィルタ実行に使用するために生成された条件式。数値変換の結果はこのフィールドを参照し、直接書き戻さないでください。
content.data[].status integer 0 は有効、2 は無効、3 は削除。未削除の照会には無効も含まれます。
content.data[].creator string 作成者 ID の UUID。
content.data[].updator string 更新者 ID。空の場合があります。
content.data[].createAt integer 作成日時の Unix 秒。
content.data[].updateAt integer 最終更新日時の Unix 秒。未更新の場合は -1。
content.data[].deleteAt integer ソフト削除日時の Unix 秒。未削除の場合は -1。
content.data[].creatorInfo object ID 表示情報。有効な ID がない場合は {}。
content.data[].creatorInfo.uuid string ID の UUID。省略可能。
content.data[].creatorInfo.status integer アカウント状態。省略可能。
content.data[].creatorInfo.wsAccountStatus integer ワークスペースとの関係状態。省略可能。
content.data[].creatorInfo.name string 表示名。
content.data[].creatorInfo.username string ログイン名。
content.data[].creatorInfo.email string メールアドレスまたはシステム ID。
content.data[].creatorInfo.mobile string 携帯電話番号。空の場合があります。
content.data[].creatorInfo.countryCode string 国/地域コード。省略可能。
content.data[].creatorInfo.iconUrl string アバター。省略可能。
content.data[].creatorInfo.acntWsNickname string ワークスペースのニックネーム。省略可能。
content.data[].updatorInfo object ID 表示情報。有効な ID がない場合は {}。
content.data[].updatorInfo.uuid string ID の UUID。省略可能。
content.data[].updatorInfo.status integer アカウント状態。省略可能。
content.data[].updatorInfo.wsAccountStatus integer ワークスペースとの関係状態。省略可能。
content.data[].updatorInfo.name string 表示名。
content.data[].updatorInfo.username string ログイン名。
content.data[].updatorInfo.email string メールアドレスまたはシステム ID。
content.data[].updatorInfo.mobile string 携帯電話番号。空の場合があります。
content.data[].updatorInfo.countryCode string 国/地域コード。省略可能。
content.data[].updatorInfo.iconUrl string アバター。省略可能。
content.data[].updatorInfo.acntWsNickname string ワークスペースのニックネーム。省略可能。
content.declaration object ワークスペースの共通宣言。空の場合があります。
pageInfo.pageIndex integer 現在のページ。
pageInfo.pageSize integer 1 ページあたりの件数。
pageInfo.count integer このページの件数。
pageInfo.totalCount integer 条件に一致する総件数。
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 10,
        "uuid": "blist_example",
        "workspaceUUID": "wksp_example",
        "name": "ヘルスチェックログを無視",
        "desc": "本番 nginx のヘルスチェックリクエストをフィルタします。",
        "type": "logging",
        "source": "nginx",
        "sources": [],
        "filters": [
          {
            "name": "path",
            "condition": "and",
            "operation": "=",
            "value": [
              "/healthz"
            ]
          }
        ],
        "conditions": "{ `source` =  'nginx'  and (`path` =  '/healthz' )}",
        "status": 0,
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785427200,
        "updateAt": -1,
        "deleteAt": -1,
        "creatorInfo": {},
        "updatorInfo": {}
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "count": 1,
    "totalCount": 1
  }
}

エラーレスポンス

認証、レート制限、共通リクエストエラーについては、共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータを使用したか、パラメータがルールに違反しています パラメータ解析に失敗しました Query パラメータ表と例を確認してください。
500 ft.InternalServerError ルールの読み取りまたはレスポンスのフォーマットに失敗しました 内部エラー 照会条件と UUID を確認して再試行してください。失敗が続く場合は traceId を提供してください。
403 ft.Forbidden API Key にこの操作権限がないか、ワークスペースのバージョンがブラックリスト機能をサポートしていません 操作権限がありません 対応する権限の API Key と、この機能をサポートするワークスペースを使用してください。

フィードバック

このページは役に立ちましたか?