コンテンツにスキップ

取得



GET /api/v1/blacklist/{blist_uuid}/get

概要

現在のワークスペースで指定したブラックリストルールの保存済み設定全体を取得します。

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

リストから blist_uuid を選択すると、status=0/2 のルールを取得できます。filters は元の入力、conditions は生成された実際の条件を返し、一覧の creatorInfo/updatorInfo は含まれません。対象が別ワークスペースに属する場合、削除済みの場合、または存在しない場合は、いずれも 404 を返します。

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

パスパラメーター

パラメーター名 型 必須 説明
blist_uuid string Y 現在のワークスペースにおける未削除ルールのパス UUID。有効および無効のルールを取得/変更できます。
null 許可: False
例: blist_example
取得または入力方法: ブラックリスト一覧 の content.data[].uuid から取得します。

リクエストヘッダー

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

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/blacklist/blist_example/get' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

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

フィールド 型 説明
content.id integer または null レコード番号。新規項目の作成/インポート時は永続化前のスナップショットのため null になる可能性があります。操作には uuid を使用してください。
content.uuid string blist_ ルール UUID。
content.workspaceUUID string 所属ワークスペース UUID。
content.name string ルール名。
content.desc string ルールの説明。
content.type string データカテゴリ。
content.source string 保存された単一/すべてのソース表現。空の場合があります。
content.sources array<string> 保存された複数のソース名。空でない場合に優先されます。
content.sources[] string 個々のソース名。
content.filters array<object> または object または null 元の条件配列。履歴レコードでは {} または null の場合もあります。
content.filters[].name string リーフフィールド名、または履歴グループのプレースホルダー名。
content.filters[].condition string 同じ階層の連結子。
content.filters[].operation string 演算子。履歴項目では op が使われ、省略されることがあります。
content.filters[].op string 履歴の演算子エイリアス。省略可能です。
content.filters[].value JSON 保存された値または値の配列。
content.filters[].value[] JSON 個々の元の値。
content.filters[].filters array<object> ネストされた条件グループ。省略可能で、再帰的に同じ条件構造を持ちます。
content.conditions string フィルタ実行用に生成された条件式。数値変換結果はこのフィールドで確認し、直接書き戻さないでください。
content.status integer 0 は有効、2 は無効、3 は削除。削除以外のクエリには無効も含まれます。
content.creator string 作成者のアイデンティティ UUID。
content.updator string 更新者のアイデンティティ。空の場合があります。
content.createAt integer 作成日時の Unix 秒。
content.updateAt integer 最終更新日時の Unix 秒。未更新の場合は -1。
content.deleteAt integer ソフト削除日時の Unix 秒。未削除の場合は -1。
content.declaration object ワークスペースの共通宣言。
{
  "code": 200,
  "content": {
    "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,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
404 ft.InvalidBlacklistuuid 現在のワークスペースで指定された未削除ルールが見つからない ブラックリストが存在しません 現在のワークスペースの一覧から有効な UUID を再取得してください。
500 ft.InternalServerError ルールの読み取りまたはレスポンスのフォーマットに失敗 内部エラー クエリ条件と UUID を確認して再試行してください。継続的に失敗する場合は traceId を提供してください。
403 ft.Forbidden API Key にこの操作権限がない、またはワークスペースのバージョンがブラックリスト機能をサポートしていない 操作権限がありません 対応する権限を持つ API Key と、この機能をサポートするワークスペースを使用してください。

フィードバック

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