一覧¶
GET /api/v1/tag/list
概要¶
現在のワークスペースにおける有効なタグ、およびリソースの関連付けと権限の概要をページ単位で取得します。
呼び出し前の準備と使用手順¶
タグ ID の降順で、status=0 のみを対象とします。現在の公開エントリポイントでは、このページの 4 つの Query のみをサポートし、Front の scope/includeGlobal/displayType や KV フィルタは透過しません。内部でサポートされているからといって、これらの未宣言フィールドを追加しないでください。リスト内の scope は、呼び出し元が使用可能なタグを選択するためのものですが、scope はリソース権限を代替しません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得方法または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| filter | string | 任意。該当タイプで現在参照されているタグのみを検索し、参照がない場合は空を返します。search と AND で組み合わせます。指定しない場合は、すべての有効なタグ(通常のタグおよびコロンを含む名前のタグ)を検索します。 null を許可: False 指定可能な値: ['BoardRefTagObject', 'ViewerRefTagObject', 'CheckerRefTagObject', 'SmartCheckerRefTagObject', 'AiCheckerRefTagObject', 'DialingRefTagObject'] 例: BoardRefTagObject取得方法または入力方法: リソース関連付けタイプを選択します。BoardRefTagObject はダッシュボード、ViewerRefTagObject はエクスプローラー、CheckerRefTagObject は通常モニター、SmartCheckerRefTagObject はインテリジェントモニタリング、AiCheckerRefTagObject は AI モニタリング、DialingRefTagObject は Synthetic テストです。 |
|
| pageIndex | integer | 任意。デフォルトは 1、最小値は 1。 null を許可: False $minValue: 1 例: 1取得方法または入力方法: 1 から開始し、トップレベルの pageInfo に従ってページ単位で読み取ります。 |
|
| pageSize | integer | 任意。デフォルトは 10、最大値は 10000、小さいページサイズを推奨します。 null を許可: False $maxValue: 10000 $minValue: 1 例: 10取得方法または入力方法: 1~10000 の範囲で適切なページサイズを選択します。 |
|
| search | string | 任意。name の部分一致で、先頭と末尾の空白を除去します。%/_ は SQL LIKE のセマンティクスに従い、説明は検索しません。 null を許可: False 例: production取得方法または入力方法: 対象タグ名のキーワード。 |
パラメータ補足説明¶
データ説明
- リクエストパラメータの説明
| パラメータ名 | 型 | 説明 |
|---|---|---|
| filter | string | 列挙値(ダッシュボードに関連付けられたタグ: BoardRefTagObject、エクスプローラーに関連付けられたタグ: ViewerRefTagObject、通常モニターに関連付けられたタグ: CheckerRefTagObject、インテリジェントモニターに関連付けられたタグ: SmartCheckerRefTagObject、AI セマンティックモニターに関連付けられたタグ: AiCheckerRefTagObject) |
- レスポンスパラメータの説明
| パラメータ名 | 型 | 説明 |
|---|---|---|
| name | string | タグ名 |
| description | string | フィールドの説明情報 |
| color | string | フロントエンドとバックエンドで取り決めた色タイプ。default、style_key1、style_key2 ~~ |
- color フィールドの色タイプ対応:
{ "default": {"background": "#CCE6FF", "color": "rgba(0,0,0,0.8)"}, "style_key1": {"background": "#3333FE", "color": "#FFFFFF"}, "style_key2": {"background": "#428BCA", "color": "#FFFFFF"}, "style_key3": {"background": "#364450", "color": "#FFFFFF"}, "style_key4": {"background": "#E0E1FF", "color": "rgba(0,0,0,0.8)"}, "style_key5": {"background": "#9400D3", "color": "#FFFFFF"}, "style_key6": {"background": "#EDDBFF", "color": "rgba(0,0,0,0.8)"}, "style_key7": {"background": "#CC328B", "color": "#FFF"}, "style_key8": {"background": "#FCDEF0", "color": "rgba(0,0,0,0.8)"}, "style_key9": {"background": "#DC143D", "color": "#FFFFFF"}, "style_key10": {"background": "#FCBABA", "color": "rgba(0,0,0,0.8)"}, "style_key11": {"background": "#BD0B48", "color": "#FFFFFF"}, "style_key12": {"background": "#FDECD2", "color": "rgba(0,0,0,0.8)"}, "style_key13": {"background": "#FFC29C", "color": "rgba(0,0,0,0.8)"}, "style_key14": {"background": "#ED9120", "color": "#FFFFFF"}, "style_key15": {"background": "#CD5B44", "color": "#FFFFFF"}, "style_key16": {"background": "#FAF570", "color": "rgba(0,0,0,0.8)"}, "style_key17": {"background": "#C29953", "color": "#FFFFFF"}, "style_key18": {"background": "#02B140", "color": "#FFFFFF"}, "style_key19": {"background": "#D5F4D5", "color": "rgba(0,0,0,0.8)"}, "style_key20": {"background": "#009966", "color": "#FFFFFF"}, "style_key21": {"background": "#023220", "color": "#FFFFFF"}, "style_key22": {"background": "#E7E7E7", "color": "rgba(0,0,0,0.8)"}, "style_key23": {"background": "#808080", "color": "#FFFFFF"} }
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/tag/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
現在のページのタグ。結果が空の場合は []。 |
| content.data[].uuid | string | tag_ タグ UUID。 |
| content.data[].name | string | タグ名。 |
| content.data[].description | string | 用途の説明。 |
| content.data[].colour | string | 色の表現。 |
| content.data[].scope | array<string> |
正規化されたスコープ。過去の null/空の scope は ["all"] として返されます。 |
| content.data[].scope[] | string | all/scene/monitor/dialing/security/infrastructure/catalog のいずれか。 |
| content.data[].creator | string | 作成者の識別情報。 |
| content.data[].updator | string | 最終更新者の識別情報。 |
| content.data[].createAt | integer | 作成 Unix 秒。 |
| content.data[].updateAt | integer | 更新 Unix 秒。未更新の場合は -1。 |
| content.data[].id | string | リスト互換フィールド。uuid と同じで、データベースの数値 ID ではありません。 |
| content.data[].creatorInfo | object | 識別情報の概要。一致するプロフィールがない場合は {}。 |
| content.data[].creatorInfo.uuid | string | 識別 UUID。省略可能。 |
| content.data[].creatorInfo.status | integer | アカウント/主体のステータス。省略可能。 |
| content.data[].creatorInfo.wsAccountStatus | integer | ワークスペースメンバーシップのステータス。省略可能。 |
| content.data[].creatorInfo.name | string | 表示名。 |
| content.data[].creatorInfo.username | string | ログイン名。省略可能。 |
| content.data[].creatorInfo.email | string | メールアドレスまたはシステム識別子。省略可能。 |
| content.data[].creatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].creatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].creatorInfo.iconUrl | string | アバター。省略可能。 |
| content.data[].creatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.data[].updatorInfo | object | 識別情報の概要。一致するプロフィールがない場合は {}。 |
| content.data[].updatorInfo.uuid | string | 識別 UUID。省略可能。 |
| content.data[].updatorInfo.status | integer | アカウント/主体のステータス。省略可能。 |
| content.data[].updatorInfo.wsAccountStatus | integer | ワークスペースメンバーシップのステータス。省略可能。 |
| content.data[].updatorInfo.name | string | 表示名。 |
| content.data[].updatorInfo.username | string | ログイン名。省略可能。 |
| content.data[].updatorInfo.email | string | メールアドレスまたはシステム識別子。省略可能。 |
| content.data[].updatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].updatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].updatorInfo.iconUrl | string | アバター。省略可能。 |
| content.data[].updatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.data[].tagPermissionInfo | object | dashboard タイプのタグ権限設定。未設定の場合は {}。現在の呼び出し元に対する最終的な認可結果ではありません。 |
| content.data[].tagPermissionInfo.id | integer | エンティティレコード番号。リストの id は UUID 文字列です。リストのフィールドを参照してください。 |
| content.data[].tagPermissionInfo.uuid | string | tag_ タグ UUID。 |
| content.data[].tagPermissionInfo.workspaceUUID | string | 所属ワークスペース。 |
| content.data[].tagPermissionInfo.status | integer | 0 は有効、3 は削除。その他の過去のステータスは実際のデータに基づきます。 |
| content.data[].tagPermissionInfo.creator | string | 作成者の識別情報。 |
| content.data[].tagPermissionInfo.updator | string | 最終更新者の識別情報。 |
| content.data[].tagPermissionInfo.createAt | integer | 作成 Unix 秒。 |
| content.data[].tagPermissionInfo.updateAt | integer | 更新 Unix 秒。未更新の場合は -1。 |
| content.data[].tagPermissionInfo.deleteAt | integer | 削除 Unix 秒。未削除の場合は -1。 |
| content.data[].tagPermissionInfo.tagUUID | string | 現在のタグ UUID。 |
| content.data[].tagPermissionInfo.type | string | この一覧クエリでは dashboard 権限タイプに固定されます。 |
| content.data[].tagPermissionInfo.permissionSet | array<string> |
設定された操作主体のリスト。 |
| content.data[].tagPermissionInfo.permissionSet[] | string | アカウント/チーム/ロールの識別子。 |
| content.data[].tagPermissionInfo.permissionSetInfo | object | 対応するリストが空でない場合にのみ、主体識別子から情報へのマッピングを提供します。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体 | object | アカウントの完全な識別情報の概要、またはロール/チームの name/status。情報がない場合は {}。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体.uuid | string | 識別 UUID。省略可能。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体.status | integer | アカウント/主体のステータス。省略可能。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体.wsAccountStatus | integer | ワークスペースメンバーシップのステータス。省略可能。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体.name | string | 表示名。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体.username | string | ログイン名。省略可能。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体.email | string | メールアドレスまたはシステム識別子。省略可能。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体.iconUrl | string | アバター。省略可能。 |
| content.data[].tagPermissionInfo.permissionSetInfo.主体.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.data[].tagPermissionInfo.readPermissionSet | array<string> |
設定された読み取り主体のリスト。 |
| content.data[].tagPermissionInfo.readPermissionSet[] | string | アカウント/チーム/ロールの識別子。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo | object | 対応するリストが空でない場合にのみ、主体識別子から情報へのマッピングを提供します。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体 | object | アカウントの完全な識別情報の概要、またはロール/チームの name/status。情報がない場合は {}。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体.uuid | string | 識別 UUID。省略可能。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体.status | integer | アカウント/主体のステータス。省略可能。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体.wsAccountStatus | integer | ワークスペースメンバーシップのステータス。省略可能。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体.name | string | 表示名。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体.username | string | ログイン名。省略可能。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体.email | string | メールアドレスまたはシステム識別子。省略可能。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体.iconUrl | string | アバター。省略可能。 |
| content.data[].tagPermissionInfo.readPermissionSetInfo.主体.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.declaration | object | 共通宣言。 |
| pageInfo.pageIndex | integer | ページ番号。 |
| pageInfo.pageSize | integer | ページサイズ。 |
| pageInfo.count | integer | このページの件数。 |
| pageInfo.totalCount | integer | 条件に一致する総件数。 |
{
"code": 200,
"content": {
"data": [
{
"uuid": "tag_example",
"name": "production",
"description": "生产资源统一标记。",
"colour": "default",
"scope": [
"scene",
"monitor"
],
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"id": "tag_example",
"tagPermissionInfo": {},
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 未宣言の Query パラメータを使用した、またはパラメータがルールに違反している | パラメータ解析に失敗しました | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | タグ、参照/権限、または識別情報の読み取りとレスポンスのフォーマットに失敗しました | 内部エラー | ワークスペースとクエリ条件を確認し、しばらくしてから再試行してください。失敗が続く場合は traceId を提供してください。 |