コンテンツにスキップ

エクスポート



POST /api/v1/tag/export

概要

現在のワークスペースのタグを、移行可能な設定配列としてエクスポートします。

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

POST では URL Query でフィルタリングします。Query が空でない場合は JSON Body を使用しません。フィルタがない場合は、明示的に ?search= に空文字列を指定するか、Content-Type: application/json を指定して {} を渡します。それ以外の場合、ルートが非 JSON のリクエストボディを読み取ると 415 が報告され、一律 500 になる可能性があります。戻り値は統一 JSON の content 配列であり、ファイルダウンロードではありません。現在のワークスペースの status=0 のタグのみをエクスポートし、id の降順で、name/description/colour/scope を保持します。UUID、参照、リソース権限、時刻はエクスポートしません。一致するものがない場合は、成功時に [] を返します。

リクエストヘッダー

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

Query リクエストパラメータ

パラメータ名 型 必須 説明
filter string 任意。このタイプで現在参照されているタグのみを検索し、参照がない場合は空を返します。search と組み合わせる場合は AND 条件になります。指定しない場合は、通常のタグおよびコロン付き名称のタグを含む、すべての有効なタグを検索します。エクスポートでは、追加で SecurityRuleRefTagObject セキュリティルールを許可します。
null を許可: False
選択可能な値: ['BoardRefTagObject', 'ViewerRefTagObject', 'CheckerRefTagObject', 'SmartCheckerRefTagObject', 'AiCheckerRefTagObject', 'DialingRefTagObject', 'SecurityRuleRefTagObject']
例: BoardRefTagObject
取得方法または入力方法: リソースの関連タイプを選択します。BoardRefTagObject はダッシュボード、ViewerRefTagObject はエクスプローラー、CheckerRefTagObject は通常のモニタリング、SmartCheckerRefTagObject はインテリジェントモニタリング、AiCheckerRefTagObject は AI モニタリング、DialingRefTagObject は Synthetic テストです。
search string 任意。name の部分一致で検索し、先頭と末尾の空白を除去します。%/_ は SQL LIKE のセマンティクスに従い、説明は検索しません。
null を許可: False
例: production
取得方法または入力方法: 対象タグ名のキーワード。

パラメータ補足説明

この API はグローバルタグを単独でエクスポートするために使用し、ワークスペースリソースのエクスポートタスクを経由する必要はありません。

リクエスト説明

  1. エクスポートパラメータはタグ一覧 API と一致しますが、ページネーションパラメータはサポートしません。
  2. 現在サポートされているフィルタパラメータは search、filter です。
  3. 現在のワークスペースで有効なタグのみをエクスポートします。
  4. 戻り値は JSON リストであり、そのまま /tag/import のインポートテンプレートとして使用できます。

エクスポートフィールド

フィールド type 説明
name string タグ名
description string タグの説明
colour string タグの色

エクスポートされないフィールド

  • uuid
  • workspaceUUID
  • creator
  • updator
  • createAt
  • updateAt

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/tag/export?search=production' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

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

フィールド 型 説明
content array<object> テンプレート配列。一致しない場合は []。
content[].name string タグ名。
content[].description string 用途の説明。
content[].colour string 色の表現。
content[].scope array<string> 正規化されたスコープ。履歴上の null/空の scope は ["all"] として返されます。
content[].scope[] string all/scene/monitor/dialing/security/infrastructure/catalog のいずれか。
content[].declaration object 配列オブジェクトに付加される共通宣言。インポート前にテンプレートから削除します。
{
  "code": 200,
  "content": [
    {
      "name": "production",
      "description": "生产资源统一标记。",
      "colour": "default",
      "scope": [
        "scene",
        "monitor"
      ],
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータを使用した場合、またはパラメータがルールに違反した場合 パラメータの解析に失敗しました Query パラメータ表と例を確認してください。
500 ft.InternalServerError タグ、参照/権限、またはアイデンティティ情報の読み取り、およびレスポンスのフォーマットに失敗した場合 内部エラー ワークスペースとクエリ条件を確認し、しばらくしてから再試行してください。継続して失敗する場合は traceId を提供してください。

フィードバック

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