ワークスペースリソースのインポート¶

POST /api/v1/workspace/resource/upload

概要¶

ワークスペースリソースの圧縮パッケージをアップロードし、インポートを開始します

パラメータ補足説明¶

1. API の用途

ワークスペースリソースの圧縮パッケージをアップロードし、インポートタスクを開始します。

Scopedb への移行時、新規作成されるログインデックス（ダイレクト書き込み、クローンを含む）の isFullLineIndex=0/false は 1 に自動的に適合され、元のファイルは変更されません。既存インデックスの skip は設定を変更しません。フルラインで非 Scopedb に移行し、recover がフルラインへのダウングレードを要求する場合、項目全体がスキップされ、クローン設定とソースインデックスは1つの項目として書き込み前にチェックされます。上書き時に新規作成されるクローンインデックスには、新規作成時の適合ルールが適用されます。パラメータ、JSON、権限、DB/Kodo などのその他のエラーは、引き続き失敗として処理されます。完了後、タスクステータスのクエリで変換、スキップ、失敗の詳細を確認できます。この適合処理は、単独のログインデックスインポート API の動作を変更しません。

この API は非同期タスク APIです。重複競合がない場合は taskId を返します。重複競合がある場合はタスクを作成せず、重複情報を直接返します。

2. リクエストタイプ

リクエストタイプは multipart/form-data です。

必須ファイルフィールド： - files

3. 推奨呼び出しフロー

まず resource.zip を各リソースの競合処理パラメータとともにアップロードします
taskId が返された場合は、タスクが作成されたことを示すため、ステータス API のポーリングを継続できます
repeat_name / repeat_identifier が返された場合は、重複が存在することを示すため、インポートポリシーを調整して再送信する必要があります

4. レスポンス分岐の説明

4.1 直接インポート可能

{
  "taskId": "task_xxx"
}

4.2 重複が存在し、呼び出し元の確認待ち

{
  "repeat_name": {
    "checker": ["CPU使用率告警"],
    "tag": ["0306"]
  },
  "repeat_identifier": {
    "dashboard": [
      {
        "identifier": "system_overview",
        "existName": "系统概览",
        "importName": "系统概览V2"
      }
    ]
  },
  "repeat_conflict": {
    "dashboard": {
      "name_and_identifier": [
        {
          "name": "CPU 监控视图",
          "identifier": "123",
          "fileName": "dashboard/CPU 监控视图.json",
          "existName": "CPU 监控视图",
          "importName": "CPU 监控视图"
        }
      ],
      "identifier": [],
      "name": []
    }
  }
}

5. 各競合処理パラメータの説明

5.1 モニター

repeatNameOp
適用リソース：モニター
選択可能な値：check / skip / recover / continue

5.2 ダッシュボードとエクスプローラーの識別 ID

repeatIdentifierOp
適用リソース：ダッシュボード、エクスプローラー
選択可能な値：check / skip / recover

5.3 ダッシュボードとエクスプローラーの3タイプの競合グループ

ダッシュボードとエクスプローラーは名前と識別 ID を同時に検出し、以下の3タイプにグループ化して返します：

name_and_identifier：名前と識別 ID が同時に競合
identifier：識別 ID のみ競合
name：名前のみ競合

対応する処理パラメータ：

repeatDashboardNameAndIdentifierOp
repeatDashboardIdentifierOp
repeatDashboardNameOp
repeatViewerNameAndIdentifierOp
repeatViewerIdentifierOp
repeatViewerNameOp

上記のパラメータはいずれも check / skip / recover のみをサポートし、skip と recover はグループ単位で有効になります。

5.4 その他の新規リソースの同名処理

以下のパラメータはいずれも以下をサポートします： - check - skip - recover

対象： - repeatNotifyObjectNameOp - repeatAlertPolicyNameOp - repeatLogBackupCfgNameOp - repeatSloNameOp - repeatSecurityRuleNameOp - repeatFieldNameOp - repeatLabelNameOp - repeatEnvVariableNameOp - repeatRoleNameOp - repeatLogIndexNameOp - repeatBlacklistNameOp - repeatPipelineNameOp - repeatRegularExpressionNameOp - repeatFieldDisplayPermissionNameOp - repeatSensitiveDataScannerNameOp

6. 現在のリソース境界の説明

現在のワークスペースリソースのインポート/エクスポートには以下の境界があります：

環境変数には scope=rum は含まれません
ログインデックスには外部インデックスと default は含まれません
フィールド管理はワークスペースのカスタムフィールドのみを処理します
データアクセスは現在、ワークスペースのインポート/エクスポートをサポートしていません

7. 互換性の説明

インポート時に、圧縮パッケージに現在サポートされていない、または無視される特殊データが含まれている場合、システムは現在の実装ルールに従ってスキップまたは失敗として処理します。実際の結果はタスクステータス API の返却値を基準としてください。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/resource/upload' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-F 'files=@guance.com' \
-F 'repeatNameOp=check' \
-F 'repeatIdentifierOp=check' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "taskId": "task_xxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}

ワークスペースリソースのインポート¶

概要¶

パラメータ補足説明¶

リクエスト例¶

レスポンス¶

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

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