エクスポート¶
POST /api/v1/blacklist/export
概要¶
指定したブラックリストの移行可能な設定 JSON をエクスポートします。
呼び出し前の確認と使用手順¶
対象ルールの UUID 配列を送信します。レスポンスは application/json の共通エンベロープであり、ファイルダウンロード/CSV/圧縮アーカイブではなく、非同期タスクでもありません。content.blacklists 配列を取得し、インポート時の Body.blacklists に使用します。ヒットした項目が空でない場合はヒットした項目のみをエクスポートし、リクエストしたすべての UUID が揃っているかは確認しません。まったくヒットしない場合([] を含む)は 404 を返します。
エクスポートには uuid、ワークスペース、status、conditions、作成者情報は含まれません。元の無効状態を保持する用途には使用できません。ワークスペースリソースパックのエクスポートにおける is_disable は別フローのもので、本 API のフィールドではありません。移行前に、移行先ワークスペースに同一フィールドおよびソースが存在するか確認してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| blacklistUUIDs[*] | string | 文字列要素です。null、数値、オブジェクトを渡さないでください。渡すと strip 処理で 500 になる可能性があります。 例: blist_example取得または入力方法: ブラックリスト一覧内の単一ルールの uuid を取得します。 |
|
| blacklistUUIDs | array | Y | 必須のルール UUID 配列です。カンマ区切り文字列ではありません。サーバー側で各項目の先頭と末尾の空白を除去し、空文字列は無視します。一致しない UUID は一部の一括操作で無視されますが、引き続き項目ごとに確認してください。 null を許可: False 例: ["blist_example"]取得または入力方法: ブラックリスト一覧から実際の uuid を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/blacklist/export' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"blacklistUUIDs":["blist_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.blacklists | array<object> |
インポート時の blacklists として直接使用できる設定配列です。現在のワークスペースで未削除かつヒットした項目のみを含みます。 |
| content.blacklists[].name | string | ルール名。 |
| content.blacklists[].desc | string | ルール説明。 |
| content.blacklists[].type | string | データカテゴリ。 |
| content.blacklists[].source | string | 保存された単一/全ソース表現。空の場合があります。 |
| content.blacklists[].sources | array<string> |
保存された複数のソース名。空でない場合はこちらが優先されます。 |
| content.blacklists[].sources[] | string | 単一のソース名。 |
| content.blacklists[].filters | array<object> または object または null | 元の条件配列。履歴レコードでは {} または null の場合もあります。 |
| content.declaration | object | 共通宣言。インポート時の単一 blacklist オブジェクトには含めません。 |
{
"code": 200,
"content": {
"blacklists": [
{
"name": "忽略健康检查日志",
"desc": "过滤生产nginx健康检查请求。",
"type": "logging",
"source": "nginx",
"sources": [],
"filters": [
{
"name": "path",
"condition": "and",
"operation": "=",
"value": [
"/healthz"
]
}
]
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の JSON ファイル形式エラー | パラメータ表の JSON オブジェクトを送信してください。 |
| 404 | ft.InvalidBlacklistuuid | 現在のワークスペースの未削除ルールが 1 件もヒットしない(空配列を含む) | ブラックリストが存在しません | UUID とワークスペースを確認してから再エクスポートしてください。 |
| 500 | ft.InternalServerError | ルールのクエリ、エクスポートの組み立て、またはレスポンスのフォーマットに失敗 | 内部エラー | クエリ条件と UUID を確認して再試行してください。継続的に失敗する場合は traceId を提供してください。 |
| 403 | ft.Forbidden | API Key にこの操作権限がない、またはワークスペースのバージョンがブラックリスト機能をサポートしていない | 操作権限がありません | 対応する権限の API Key と、この機能をサポートするワークスペースを使用してください。 |