ワークスペースリソースのインポート¶
POST /api/v1/workspace/resource/upload
概要¶
リソース ZIP をアップロードし、各種競合ポリシーに従ってチェックまたはインポートタスクを開始します。
呼び出し前の確認と使用手順¶
現在の Key には workspace.setManage が必要です。タスクは現在のワークスペースと、発行元 Key のリソース UUID にのみ属します。同じワークスペース内の別の Key は、同じロールであってもこのタスクを読み取り/キャンセルできません。同じ Key をローテーションしてもリソース UUID は保持されます。taskId と API Key の値を混同しないでください。
multipart/form-data を使用し、ZIP フィールドは files です。1 ファイルあたり最大 100MiB です。Form の各ポリシーは同じ multipart 内の通常のテキストフィールドであり、JSON ではありません。本製品がエクスポートした resource.zip を優先的に使用し、ディレクトリと JSON 構造を保持してください。ダッシュボード、モニター、エクスプローラー、通知先、SLO、セキュリティモニタリング、アラートポリシー、データ転送、ワークスペース属性クレーム、フィールド設定、タグ、環境変数、ロール、ログインデックス、ブラックリスト、Pipeline、正規表現、フィールドマスキングルール、機密データスキャンルールなどの設定ディレクトリを含みます。業務ログや任意の圧縮ファイルで代替してアップロードすることはできません。対象ワークスペースで先にバックアップしてから recover を選択してください。
まず一時 ZIP を保存し、パッケージ構造/JSON とバージョン、数量、種類の制限を確認してから、各リソースのデフォルト check ポリシーで同名を事前チェックします。確認が必要な競合がある場合、HTTP 200/success=true の content には repeat_name/repeat_identifier/repeat_conflict が返り、taskId は含まれず、インポートは開始されていません。具体的なグループに応じて skip/recover を選択し、再アップロードしてください。HTTP 200 だけを確認しないでください。ポリシーはリソースごとに独立しており、repeatNameOp はモニターの制御にのみ対応し、その他には個別のパラメータがあります。ポリシーフィールドはルートの Form 宣言で列挙値を検証し、不正な値はまず共通パラメータエラーとして拒否されます。
確認が不要な場合にのみ taskId を返し、キューに登録します。非同期でリソース/項目ごとに処理し、UUID の再生成、参照の変換、部分成功の保持が可能です。モジュールをまたぐ全体ロールバックはありません。属性クレームなどのリソースは対象設定を上書きする可能性があり、データベース全体の復元ではありません。インポートには生のテレメトリデータは含まれません。同じアップロードを繰り返すたびに、リソースが新規作成されたり重複して上書きされたりする可能性があり、冪等なリクエストではありません。
完全な成功/失敗/変換/スキップ情報を読み取るには、リソースタスクの進捗を使用します。status=ok または success=true だけではすべてのインポートを証明するには不十分です。successCount/failCount、failedItems、skippedTags などを確認し、対象リソースが実際に利用可能であることを検証してください。パッケージ内のモニター/アラート/転送などの設定は、インポート後に関連タスクが有効になる可能性があるため、実行前に対象と認証情報を確認してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Form パラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| repeatAlertPolicyNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、アラートポリシーのみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内のアラートポリシーについて、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatBlacklistNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、ブラックリストのみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内のブラックリストについて、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatDashboardIdentifierOp | string | check/skip/recover を選択可能。ダッシュボードの識別子のみが競合する場合のポリシーで、デフォルトでは repeatIdentifierOp を継承します。check は競合を返してキューに登録せず、skip はスキップし、recover はそのグループに基づいて対象を特定して上書きします。上書きは追加マージではないため、事前にバックアップが必要です。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: アップロードの事前チェックで repeat_conflict の該当グループを確認してから選択します。 |
|
| repeatDashboardNameAndIdentifierOp | string | check/skip/recover を選択可能。ダッシュボードの名前および識別子の両方が競合する場合のポリシーで、デフォルトでは repeatIdentifierOp を継承します。check は競合を返してキューに登録せず、skip はスキップし、recover はそのグループに基づいて対象を特定して上書きします。上書きは追加マージではないため、事前にバックアップが必要です。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: アップロードの事前チェックで repeat_conflict の該当グループを確認してから選択します。 |
|
| repeatDashboardNameOp | string | check/skip/recover を選択可能。ダッシュボードの名前のみが競合する場合のポリシーで、デフォルトは check です。check は競合を返してキューに登録せず、skip はスキップし、recover はそのグループに基づいて対象を特定して上書きします。上書きは追加マージではないため、事前にバックアップが必要です。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: アップロードの事前チェックで repeat_conflict の該当グループを確認してから選択します。 |
|
| repeatEnvVariableNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、環境変数のみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内の環境変数について、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatFieldDisplayPermissionNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、フィールドマスキングルールのみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内のフィールドマスキングルールについて、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatFieldNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、フィールド設定のみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内のフィールド設定について、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatIdentifierOp | string | check/skip/recover を選択可能で、デフォルトは check です。2 種類のリソースの name_and_identifier グループおよび identifier グループのデフォルト値として機能し、name グループ単独のデフォルトは引き続き check です。専用ポリシーが優先されます。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: ダッシュボード/エクスプローラーの識別子競合に対する互換デフォルトポリシーです。 |
|
| repeatLabelNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、タグのみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内のタグについて、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatLogBackupCfgNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、データ転送のみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内のデータ転送について、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatLogIndexNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、ログインデックスのみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内のログインデックスについて、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatNameOp | string | multipart の通常テキストフィールド。デフォルトは check で、checker のみを制御します。check は競合を検出すると確認情報を返し、タスクを開始しません。skip は同名をスキップします。recover は上書きします。continue は skip/recover 以外の通常作成パスに進み、同名が必ずインポートできることを保証しません。他のリソースはこの設定を継承しません。 null を許可: False 選択可能な値: ['check', 'skip', 'recover', 'continue'] 例: check取得または入力方法: モニターの同名処理に応じて選択が必要です。まず check で確認してください。 |
|
| repeatNotifyObjectNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、通知先のみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内の通知先について、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatPipelineNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、Pipeline のみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内の Pipeline について、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatRegularExpressionNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、正規表現のみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内の正規表現について、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatRoleNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、ロールのみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内のロールについて、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatSecurityRuleNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、セキュリティモニタリングのみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内のセキュリティモニタリングについて、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatSensitiveDataScannerNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、機密データスキャンルールのみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内の機密データスキャンルールについて、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatSloNameOp | string | multipart の通常テキストフィールド。check/skip/recover を選択でき、デフォルトは check で、SLO のみを制御します。check は同名が存在するかを事前チェックし、存在する場合はキューに登録しません。skip は既存を保持してスキップします。recover は同名設定を上書きします。リソースごとの上書き対応範囲/フィールドおよびバージョン制限は、引き続きタスク結果に従います。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: リソースパッケージ内の SLO について、現在のワークスペースに同名リソースが存在するかを先に確認し、バックアップします。 |
|
| repeatViewerIdentifierOp | string | check/skip/recover を選択可能。エクスプローラーの識別子のみが競合する場合のポリシーで、デフォルトでは repeatIdentifierOp を継承します。check は競合を返してキューに登録せず、skip はスキップし、recover はそのグループに基づいて対象を特定して上書きします。上書きは追加マージではないため、事前にバックアップが必要です。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: アップロードの事前チェックで repeat_conflict の該当グループを確認してから選択します。 |
|
| repeatViewerNameAndIdentifierOp | string | check/skip/recover を選択可能。エクスプローラーの名前および識別子の両方が競合する場合のポリシーで、デフォルトでは repeatIdentifierOp を継承します。check は競合を返してキューに登録せず、skip はスキップし、recover はそのグループに基づいて対象を特定して上書きします。上書きは追加マージではないため、事前にバックアップが必要です。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: アップロードの事前チェックで repeat_conflict の該当グループを確認してから選択します。 |
|
| repeatViewerNameOp | string | check/skip/recover を選択可能。エクスプローラーの名前のみが競合する場合のポリシーで、デフォルトは check です。check は競合を返してキューに登録せず、skip はスキップし、recover はそのグループに基づいて対象を特定して上書きします。上書きは追加マージではないため、事前にバックアップが必要です。 null を許可: False 選択可能な値: ['check', 'skip', 'recover'] 例: check取得または入力方法: アップロードの事前チェックで repeat_conflict の該当グループを確認してから選択します。 |
ファイルパラメータ(multipart/form-data)¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| files | file | Y | 必須の単一 .zip ファイル。最大 100×1024×1024 バイトです。フィールド名は複数形の files です。ローカルパス文字列のみを送信することはできません。 許可されるファイル拡張子: ['zip'] 1 ファイルのサイズ上限: 100M ファイル数の上限: 1 例: @./resource.zip取得または入力方法: リソースのエクスポートタスクの完了後に返される URL からダウンロードして保存します。 |
パラメータ補足説明¶
ワークスペース移行で新しいログインデックス(直接書き込み、クローンを含む)を ScopeDB に作成する場合、isFullLineIndex=0/false を 1 に適合できます。元のファイルは変更されません。既存の skip 項目は変更されません。全行を ScopeDB 以外へ移行する場合、または recover で全行のダウングレードが要求される場合は、項目全体をスキップします。ソースとクローンは先にまとめて確認します。その他のパラメータ/JSON/権限/データベース/下流エラーは引き続き失敗として処理されます。この移行適応は独立したログインデックスインポートインターフェースを変更しません。環境変数のエクスポートには scope=rum が含まれません。ログインデックスには外部バインディングと default が含まれません。フィールド管理はワークスペースのカスタムフィールドのみです。データアクセスルールは現在、サポート対象リソースカタログに含まれていません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/workspace/resource/upload' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-F 'files=@./resource.zip' \
-F 'repeatNameOp=check' \
-F 'repeatIdentifierOp=check'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主なフィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.taskId | string | 非同期タスク ID。以降は taskId で照会/キャンセルします。ZIP のダウンロード URL や Celery 実行完了のフラグではありません。 |
| content.declaration | object | 現在のワークスペースの共通宣言。 |
| content.repeat_name | object | 事前チェックで競合がある場合にのみ返され、リソースタイプ別にグループ化された同名配列です。この分岐には taskId がなく、非同期インポートは開始されません。 |
| content.repeat_name.资源类型 | array<string> |
該当タイプで一致した既存名。例: checker/log_backup_cfg/role など。 |
| content.repeat_name.资源类型[] | string | 1 つの競合名。フィールド設定の同名は name+fieldSource で判定します。 |
| content.repeat_identifier | object | 互換確認マッピング。現在のアップロードコントローラーでは通常 {} です。 |
| content.repeat_conflict | object | ダッシュボード/エクスプローラーの詳細な競合マッピング。check が必要で、実際に競合グループが存在する場合にのみ返されます。 |
| content.repeat_conflict.dashboard.name_and_identifier | array<object> |
このタイプの名前/識別子競合項目。実際のマッチング詳細は各項目を参照してください。 |
| content.repeat_conflict.dashboard.name_and_identifier[] | object | インポート項目と既存オブジェクトの競合情報。 |
| content.repeat_conflict.dashboard.name_and_identifier[].name | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].identifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].fileName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].importName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].importIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].existName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].existIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].nameConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].existNameIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].identifierConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].existIdentifierName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name_and_identifier[].isCrossConflict | boolean | 名前と識別子が 2 つの異なる既存オブジェクトに一致した場合に true。上書き前にそれぞれ確認する必要があります。 |
| content.repeat_conflict.dashboard.name_and_identifier[].conflictUUIDs | array<string> |
この項目に関係するすべての既存リソース UUID。重複排除されますが、順序は保証されません。 |
| content.repeat_conflict.dashboard.name_and_identifier[].conflictUUIDs[] | string | 1 つの既存競合 UUID。 |
| content.repeat_conflict.dashboard.identifier | array<object> |
このタイプの名前/識別子競合項目。実際のマッチング詳細は各項目を参照してください。 |
| content.repeat_conflict.dashboard.identifier[] | object | インポート項目と既存オブジェクトの競合情報。 |
| content.repeat_conflict.dashboard.identifier[].name | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].identifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].fileName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].importName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].importIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].existName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].existIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].nameConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].existNameIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].identifierConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].existIdentifierName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.identifier[].isCrossConflict | boolean | 名前と識別子が 2 つの異なる既存オブジェクトに一致した場合に true。上書き前にそれぞれ確認する必要があります。 |
| content.repeat_conflict.dashboard.identifier[].conflictUUIDs | array<string> |
この項目に関係するすべての既存リソース UUID。重複排除されますが、順序は保証されません。 |
| content.repeat_conflict.dashboard.identifier[].conflictUUIDs[] | string | 1 つの既存競合 UUID。 |
| content.repeat_conflict.dashboard.name | array<object> |
このタイプの名前/識別子競合項目。実際のマッチング詳細は各項目を参照してください。 |
| content.repeat_conflict.dashboard.name[] | object | インポート項目と既存オブジェクトの競合情報。 |
| content.repeat_conflict.dashboard.name[].name | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].identifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].fileName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].importName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].importIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].existName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].existIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].nameConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].existNameIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].identifierConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].existIdentifierName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.dashboard.name[].isCrossConflict | boolean | 名前と識別子が 2 つの異なる既存オブジェクトに一致した場合に true。上書き前にそれぞれ確認する必要があります。 |
| content.repeat_conflict.dashboard.name[].conflictUUIDs | array<string> |
この項目に関係するすべての既存リソース UUID。重複排除されますが、順序は保証されません。 |
| content.repeat_conflict.dashboard.name[].conflictUUIDs[] | string | 1 つの既存競合 UUID。 |
| content.repeat_conflict.viewer.name_and_identifier | array<object> |
このタイプの名前/識別子競合項目。実際のマッチング詳細は各項目を参照してください。 |
| content.repeat_conflict.viewer.name_and_identifier[] | object | インポート項目と既存オブジェクトの競合情報。 |
| content.repeat_conflict.viewer.name_and_identifier[].name | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].identifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].fileName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].importName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].importIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].existName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].existIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].nameConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].existNameIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].identifierConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].existIdentifierName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name_and_identifier[].isCrossConflict | boolean | 名前と識別子が 2 つの異なる既存オブジェクトに一致した場合に true。上書き前にそれぞれ確認する必要があります。 |
| content.repeat_conflict.viewer.name_and_identifier[].conflictUUIDs | array<string> |
この項目に関係するすべての既存リソース UUID。重複排除されますが、順序は保証されません。 |
| content.repeat_conflict.viewer.name_and_identifier[].conflictUUIDs[] | string | 1 つの既存競合 UUID。 |
| content.repeat_conflict.viewer.identifier | array<object> |
このタイプの名前/識別子競合項目。実際のマッチング詳細は各項目を参照してください。 |
| content.repeat_conflict.viewer.identifier[] | object | インポート項目と既存オブジェクトの競合情報。 |
| content.repeat_conflict.viewer.identifier[].name | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].identifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].fileName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].importName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].importIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].existName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].existIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].nameConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].existNameIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].identifierConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].existIdentifierName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.identifier[].isCrossConflict | boolean | 名前と識別子が 2 つの異なる既存オブジェクトに一致した場合に true。上書き前にそれぞれ確認する必要があります。 |
| content.repeat_conflict.viewer.identifier[].conflictUUIDs | array<string> |
この項目に関係するすべての既存リソース UUID。重複排除されますが、順序は保証されません。 |
| content.repeat_conflict.viewer.identifier[].conflictUUIDs[] | string | 1 つの既存競合 UUID。 |
| content.repeat_conflict.viewer.name | array<object> |
このタイプの名前/識別子競合項目。実際のマッチング詳細は各項目を参照してください。 |
| content.repeat_conflict.viewer.name[] | object | インポート項目と既存オブジェクトの競合情報。 |
| content.repeat_conflict.viewer.name[].name | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].identifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].fileName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].importName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].importIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].existName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].existIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].nameConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].existNameIdentifier | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].identifierConflictUUID | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].existIdentifierName | string | 対応するインポート/既存オブジェクトの名前、識別子、または UUID。該当する競合側に一致しない場合、一部のフィールドは省略されます。 |
| content.repeat_conflict.viewer.name[].isCrossConflict | boolean | 名前と識別子が 2 つの異なる既存オブジェクトに一致した場合に true。上書き前にそれぞれ確認する必要があります。 |
| content.repeat_conflict.viewer.name[].conflictUUIDs | array<string> |
この項目に関係するすべての既存リソース UUID。重複排除されますが、順序は保証されません。 |
| content.repeat_conflict.viewer.name[].conflictUUIDs[] | string | 1 つの既存競合 UUID。 |
{
"code": 200,
"content": {
"taskId": "resource_task_example",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
{
"code": 200,
"content": {
"repeat_name": {
"checker": [
"已有监控器"
]
},
"repeat_identifier": {},
"repeat_conflict": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 406 | ft.UploadFileFailedParse | ZIP または検査対象リソースの JSON を読み取れない/解析できない | ファイル解析に失敗しました | サポート対象のエクスポートパッケージから再生成し、JSON とディレクトリ構造を確認してください。暗号化された ZIP や破損した ZIP はアップロードしないでください。 |
| 403 | ft.ForbiddenFreeEditionLimit | リソース数が現在のプランの制限に達している/超過している | 無料プランワークスペース {} は上限({} 個)に達したため、新規作成できません。商用プランにアップグレードすると制限を解除できます | 対象プランのクォータと現在の数量を確認し、skip ポリシーでインポート前の数量チェックを回避しないでください。 |
| 403 | ft.ForbiddenFreeEditionWorkspace | インポート対象のモニター/通知などのタイプが対象ワークスペースのプランで許可されていない | 無料プランワークスペースはこの機能をサポートしていません。商用プランにアップグレードすると制限を解除できます | サポートされていないリソースを除外するか、サポート対象のプランを選択してください。 |
| 403 | ft.Forbidden | 無料プランワークスペースではデータ転送などのリソースのインポートが許可されていない、または API 権限が不足している | 操作権限がありません | プランと権限を確認してください。 |
| 406 | ft.UnsupportShortMessage | 現在の無料プランではパッケージ内の SMS 通知先をサポートしていない | 無料プランワークスペースはSMS通知先をサポートしていません |
このオブジェクトを削除するか、サポート対象のプランを使用してください。 |
| 406 | ft.UnsupportOnCall | 現在の無料プランではパッケージ内の音声通知先をサポートしていない | ワークスペースは電話通知先をサポートしていません |
このオブジェクトを削除するか、サポート対象のプランを使用してください。 |
| 400 | ft.UnsupportFreeWorkspaceSecurityCfg | 現在の free プランではインポート対象のセキュリティ設定をサポートしていない | 無料プランワークスペースではセキュリティモニタリングルール設定をサポートしていません | プランのサポート状況を確認してください。 |
| 500 | ft.InternalServerError | タスクキャッシュ/キュー、ファイルシステム、データベース、または未処理のタスク状態/JSON 処理に失敗 | 内部エラー | まず同じワークスペースと同じ Key でタスクおよびリソースの現在の状態を照会し、キューに登録済み/一部保存済みかどうかを確認してから再試行してください。むやみにインポートや上書きを繰り返さないでください。 |