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

POST /api/v1/workspace/resource/upload

概要¶

ワークスペースリソースの圧縮ファイルをアップロードし、インポートを開始します。

パラメータ補足説明¶

1. インターフェースの用途

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

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

2. リクエストタイプ

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

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

3. 推奨呼び出しフロー

まず resource.zip をアップロードし、各リソースの競合処理パラメータを指定します。
taskId が返された場合、タスクが作成されたことを示します。続けてステータスインターフェースをポーリングできます。
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. 互換性説明

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

リクエスト例¶

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"
}

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

概要¶

パラメータ補足説明¶

リクエスト例¶

レスポンス¶

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

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