機能メニュー設定¶
POST /api/v1/workspace/menu/set
概要¶
旧 v1 プロトコルに従ってワークスペースメニューを保存します。
呼び出し前の準備と使用手順¶
workspace.setManage を持つ現在のワークスペースの Key を使用します。旧プロトコル互換の保存は、v3 と同じワークスペーストランザクションロックを経由します。旧プロトコルで表現可能な範囲に限り、システムノードを並べ替えて表示/非表示を設定し、v3 のカスタムカタログ/リソース/ロール設定は保持します。列挙されていない旧ノードはデフォルト表示に戻ります。配列内の 1 項目だけを変更する patch ではないため、完全な旧設定を先に読み取ってから変更してください。
v1 では第二階層の表示/非表示を表現できないため、保存時には履歴ルールに従って、その範囲の旧第二階層メニューをデフォルト表示に戻します。新しいクライアントでは v3 の使用を推奨します。
旧プロトコルでは expectedRevision は不要で、他の編集者が表現可能な範囲で行った表示/非表示の変更を上書きする可能性があります。同時編集では v3 を優先してください。保存は旧二階層の投影(v1 の書き込みエントリを含む)を返し、リクエストの形状に応じた value 配列を返すわけではありません。updated=true は内容が必ず変更されたことを意味せず、変更があった場合にのみルートに従ってメニュー監査が記録されます。初回保存では、デフォルト内容が同じであっても永続化され、revision が増加する可能性があります。
v1 の書き込みでは、パラメータ表に列挙された旧 Key のみを送信します。GET には Notebook などの新しい Key が含まれる可能性があるため、GET の全項目をそのまま返送することはできません。許可された旧範囲にフィルタリングし、新しいバージョンの範囲外メニューは元の設定を維持します。
Owner 権限で受け入れ確認する際は注意が必要です。有効メニューの計算ではワークスペースの isShow による非表示(区切り線を除く)は無視されますが、プラットフォームによる非表示と実際の権限の制約は引き続き受けます。一般ロールと Owner では最終的な表示が異なる場合があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| menu | array | Y | 旧プロトコル範囲を完全に指定する必須配列です。省略された旧システムノードはデフォルト表示に戻り、空配列はすべてのメニューを閉じる意味ではありません。表現されていない v3 のカスタムオブジェクト/ロール設定は保持されます。 null を許可: False 例: [{"key": "LogIndi", "value": 0}]取得または入力方法: 該当バージョンの GET の content.config を先に読み取り、返却されたメタデータを削除して、本ページのフィールドに従って構築します。 |
| menu[*] | json | Y | オブジェクト。重複する key は拒否されます。旧プロトコルではリソース認可を作成できません。null を許可: False 例: {"key": "LogIndi", "value": 0}取得または入力方法: 旧 GET が返す単一のシステム項目を使用します。 |
| menu[*].key | string | Y | 必須 Key。大文字と小文字を区別します。v1 は元の宣言で列挙された項目のみをサポートし、v2 は未知/退役した Key と互換性がありますが、それによってアクセス可能な v3 エントリが新たに追加されることはありません。 null を許可: False 選択可能な値: ['Scene', 'Events', 'ExceptionsTracking', 'Objectadmin', 'MetricQuery', 'LogIndi', 'Tracing', 'Rum', 'CloudDial', 'Security', 'GitLabCI', 'Monitor', 'Integration', 'Workspace', 'Billing'] 例: LogIndi取得または入力方法: 旧 GET の content.config[].key から元の値を取得します。 |
| menu[*].value | int | Y | 必須の JSON 整数。0/1 のみ許可され、真偽値や文字列は受け付けません。 null を許可: False 選択可能な値: [0, 1] 例: 0取得または入力方法: 0 は非表示、1 は表示です。 |
パラメータ補足説明¶
パラメータ説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| menu | array[json] | Y | メニューバー一覧 |
| key | string | Y | メニュー項目 |
| value | int | Y | 有効にするか: 0 は無効、1 は有効 |
メニュー項目の説明
| key | 説明 |
|---|---|
| Scene | シーン |
| Events | イベント |
| ExceptionsTracking | インシデント |
| Objectadmin | インフラストラクチャ |
| MetricQuery | メトリクス |
| LogIndi | ログ |
| Tracing | APM |
| Rum | RUM |
| CloudDial | Synthetic モニタリング |
| Security | セキュリティチェック |
| GitLabCI | CI 可視化 |
| Monitor | モニタリング |
| Integration | インテグレーション |
| Workspace | 管理 |
| Billing | 料金プランと請求 |
注意:
1. 未設定の場合、フロントエンドでは新しいメニューとして扱われ、デフォルトで開きます
2. 管理バックエンドに存在するメニュー設定は、ワークスペース設定の最終的な表示に影響します
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/workspace/menu/set' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"menu":[{"key":"LogIndi","value":0}]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.workspaceUUID | string | 現在の Key が属するワークスペース UUID。 |
| content.config | array<object> |
メニュー設定配列。空の結果も [] で返される場合があります。 |
| content.keyCode | string | 互換メタデータ。保存/v3 互換投影では通常 WsMenuCfg です。新しいワークスペースの旧読み取り分岐では省略される場合があります。 |
| content.updated | boolean | ワークスペース設定または v3 互換投影が存在する場合は通常 true です。今回の書き込みで変更があったかどうかを示す信頼できる指標ではなく、新しいワークスペースでは省略される場合があります。 |
| content.id | integer または null | 保存済み設定のデータベース番号。省略可能です。 |
| content.uuid | string | ctcf_設定 UUID。省略可能で、メニューノード ID としては使用されません。 |
| content.creator | string | 設定の作成者。省略可能です。 |
| content.updator | string | 設定の更新者。省略可能です。 |
| content.status | integer | 設定エンティティのステータス。省略可能です。 |
| content.createAt | integer | 作成 Unix 秒。省略可能です。 |
| content.updateAt | integer | 更新 Unix 秒。省略可能です。 |
| content.deleteAt | integer | 削除 Unix 秒。未削除の場合は -1。省略可能です。 |
| content.declaration | object | 現在のワークスペースの共通宣言。 |
| content.config[].key | string | 第一階層システムメニューの Key。そのまま返され、動的カタログとリソースはこの旧投影には含まれません。 |
| content.config[].isShow | boolean | ワークスペース設定で表示するかどうか。プラットフォームによる強制非表示や実際の権限を上書きしません。 |
| content.config[].isHide | boolean | プラットフォームによる強制非表示フラグ。表示するには isShow=true/isHide=false を同時に満たす必要があります。 |
| content.config[].children | array<object> |
第二階層システムメニューの配列。[] の場合があります。 |
| content.config[].children[].key | string | 第二階層メニューの Key。親子の組み合わせで識別子が決まります。 |
| content.config[].children[].isShow | boolean | ワークスペースによるサブメニューの表示/非表示。 |
| content.config[].children[].isHide | boolean | プラットフォームによるサブメニューの非表示フラグ。 |
| content.config[].menuGroupKey | string | 履歴サイトのグループメタデータ。省略される場合があります。 |
| content.config[].groupKey | string | 履歴グループの別名。省略される場合があります。 |
| content.config[].navGroupKey | string | 履歴ナビゲーショングループの別名。省略される場合があります。 |
{
"code": 200,
"content": {
"id": 101,
"uuid": "ctcf_menu_example",
"workspaceUUID": "wksp_example",
"keyCode": "WsMenuCfg",
"config": [
{
"key": "Scene",
"isShow": true,
"isHide": false,
"children": [
{
"key": "DashboardList",
"isShow": true,
"isHide": false
},
{
"key": "ViewerList",
"isShow": true,
"isHide": false
},
{
"key": "BuiltInViewList",
"isShow": true,
"isHide": false
},
{
"key": "LinkToTrackService",
"isShow": true,
"isHide": false
},
{
"key": "RegularReportList",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Notebook",
"isShow": true,
"isHide": false,
"children": []
},
{
"key": "Events",
"isShow": true,
"isHide": false,
"children": [
{
"key": "KeyEventsMonitor",
"isShow": true,
"isHide": false
},
{
"key": "KeyEventsMonitorChart",
"isShow": true,
"isHide": false
},
{
"key": "LogBackupExplorer",
"isShow": true,
"isHide": false
}
]
},
{
"key": "ExceptionsTracking",
"isShow": true,
"isHide": false,
"children": [
{
"key": "Exceptions",
"isShow": true,
"isHide": false
},
{
"key": "AnalysisDashboard",
"isShow": true,
"isHide": false
},
{
"key": "ExceptionsSchedule",
"isShow": true,
"isHide": false
},
{
"key": "ExceptionsTrackingConf",
"isShow": true,
"isHide": false
},
{
"key": "CrossWorkspace",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Incident",
"isShow": true,
"isHide": false,
"children": [
{
"key": "IncidentList",
"isShow": true,
"isHide": false
},
{
"key": "IncidentDashboard",
"isShow": true,
"isHide": false
},
{
"key": "IncidentSchedule",
"isShow": true,
"isHide": false
},
{
"key": "IncidentConfig",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Error",
"isShow": true,
"isHide": false,
"children": [
{
"key": "ErrorList",
"isShow": true,
"isHide": false
},
{
"key": "ErrorDashboard",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Objectadmin",
"isShow": true,
"isHide": false,
"children": [
{
"key": "ObjectadminHost",
"isShow": true,
"isHide": false
},
{
"key": "ObjectadminDocker",
"isShow": true,
"isHide": false
},
{
"key": "ObjectadminProcesses",
"isShow": true,
"isHide": false
},
{
"key": "ObjectadminDatabase",
"isShow": true,
"isHide": false
},
{
"key": "HostNetwork",
"isShow": true,
"isHide": false
},
{
"key": "ObjectadminOther",
"isShow": true,
"isHide": false
},
{
"key": "WorkspacePipelineList",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Entity",
"isShow": true,
"isHide": false,
"children": [
{
"key": "EntityList",
"isShow": true,
"isHide": false
},
{
"key": "EntityTopology",
"isShow": true,
"isHide": false
}
]
},
{
"key": "DataObservability",
"isShow": true,
"isHide": false,
"children": [
{
"key": "DataObservabilityOverview",
"isShow": true,
"isHide": false
},
{
"key": "DataObservabilityCatalog",
"isShow": true,
"isHide": false
},
{
"key": "DataObservabilityJobs",
"isShow": true,
"isHide": false
},
{
"key": "DataObservabilityLineage",
"isShow": true,
"isHide": false
}
]
},
{
"key": "MetricQuery",
"isShow": true,
"isHide": false,
"children": [
{
"key": "MetricAnalysis",
"isShow": true,
"isHide": false
},
{
"key": "MetricMap",
"isShow": true,
"isHide": false
},
{
"key": "MetricIndicator",
"isShow": true,
"isHide": false
},
{
"key": "WorkspacePipelineList",
"isShow": true,
"isHide": false
},
{
"key": "DataAccessRuleList",
"isShow": true,
"isHide": false
}
]
},
{
"key": "LogIndi",
"isShow": false,
"isHide": false,
"children": [
{
"key": "Log",
"isShow": true,
"isHide": false
},
{
"key": "LogTrackError",
"isShow": true,
"isHide": false
},
{
"key": "LogPipelineList",
"isShow": true,
"isHide": false
},
{
"key": "LogIndexList",
"isShow": true,
"isHide": false
},
{
"key": "LogFilterRuleList",
"isShow": true,
"isHide": false
},
{
"key": "LogBackupExplorer",
"isShow": true,
"isHide": false
},
{
"key": "LogQueryRuleList",
"isShow": true,
"isHide": false
},
{
"key": "MetricIndicator",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Tracing",
"isShow": true,
"isHide": false,
"children": [
{
"key": "LinkToTrackService",
"isShow": true,
"isHide": false
},
{
"key": "LinkToTrackDashboard",
"isShow": true,
"isHide": false
},
{
"key": "LinkToTrackLink",
"isShow": true,
"isHide": false
},
{
"key": "LinkToTrackError",
"isShow": true,
"isHide": false
},
{
"key": "LinkToTrackProfile",
"isShow": true,
"isHide": false
},
{
"key": "LogBackupExplorer",
"isShow": true,
"isHide": false
},
{
"key": "DataAccessRuleList",
"isShow": true,
"isHide": false
},
{
"key": "MetricIndicator",
"isShow": true,
"isHide": false
},
{
"key": "WorkspacePipelineList",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Rum",
"isShow": true,
"isHide": false,
"children": [
{
"key": "RumList",
"isShow": true,
"isHide": false
},
{
"key": "RumViewer",
"isShow": true,
"isHide": false
},
{
"key": "RumDashboard",
"isShow": true,
"isHide": false
},
{
"key": "RumHeatMap",
"isShow": true,
"isHide": false
},
{
"key": "RumTrack",
"isShow": true,
"isHide": false
},
{
"key": "LogBackupExplorer",
"isShow": true,
"isHide": false
},
{
"key": "DataAccessRuleList",
"isShow": true,
"isHide": false
},
{
"key": "MetricIndicator",
"isShow": true,
"isHide": false
},
{
"key": "WorkspacePipelineList",
"isShow": true,
"isHide": false
}
]
},
{
"key": "CloudBilling",
"isShow": true,
"isHide": false,
"children": [
{
"key": "ColudBillingExplorer",
"isShow": true,
"isHide": false
},
{
"key": "ColudBillingDashboard",
"isShow": true,
"isHide": false
},
{
"key": "CloudBillingBudget",
"isShow": true,
"isHide": false
}
]
},
{
"key": "CloudDial",
"isShow": true,
"isHide": false,
"children": [
{
"key": "CloudDialList",
"isShow": true,
"isHide": false
},
{
"key": "CloudDialDashboard",
"isShow": true,
"isHide": false
},
{
"key": "CloudDialExplorer",
"isShow": true,
"isHide": false
},
{
"key": "CloudDialSelfNodeList",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Security",
"isShow": true,
"isHide": false,
"children": [
{
"key": "SecuritySIEMRules",
"isShow": true,
"isHide": false
},
{
"key": "SecuritySIEMExplorer",
"isShow": true,
"isHide": false
},
{
"key": "SecuritySIEMExecutionLogs",
"isShow": true,
"isHide": false
}
]
},
{
"key": "AIMonitor",
"isShow": true,
"isHide": false,
"children": [
{
"key": "AIMonitorList",
"isShow": true,
"isHide": false
},
{
"key": "AIMonitorExplorer",
"isShow": true,
"isHide": false
},
{
"key": "AIMonitorEvaluator",
"isShow": true,
"isHide": false
},
{
"key": "AIMonitorDashboard",
"isShow": true,
"isHide": false
}
]
},
{
"key": "GitLabCI",
"isShow": true,
"isHide": false,
"children": [
{
"key": "GitLabCIExplorer",
"isShow": true,
"isHide": false
},
{
"key": "GitLabCIDashboard",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Monitor",
"isShow": true,
"isHide": false,
"children": [
{
"key": "CheckerRuleList",
"isShow": true,
"isHide": false
},
{
"key": "AICheckerRuleList",
"isShow": true,
"isHide": false
},
{
"key": "SmartCheckerRuleList",
"isShow": true,
"isHide": false
},
{
"key": "SLOList",
"isShow": true,
"isHide": false
},
{
"key": "SilenceList",
"isShow": true,
"isHide": false
},
{
"key": "CheckerRuleGroupList",
"isShow": true,
"isHide": false
},
{
"key": "AlertToList",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Integration",
"isShow": true,
"isHide": false,
"children": [
{
"key": "IntegrationList",
"isShow": true,
"isHide": false
},
{
"key": "Datakit",
"isShow": true,
"isHide": false
},
{
"key": "GatewayAccess",
"isShow": true,
"isHide": false
},
{
"key": "ImApplication",
"isShow": true,
"isHide": false
},
{
"key": "FunctionDetail",
"isShow": true,
"isHide": false
},
{
"key": "CloudAccountList",
"isShow": true,
"isHide": false
},
{
"key": "ExternalDataSourceList",
"isShow": true,
"isHide": false
},
{
"key": "DCA",
"isShow": true,
"isHide": false
},
{
"key": "Mobile",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Workspace",
"isShow": true,
"isHide": false,
"children": [
{
"key": "WorkspaceDetail",
"isShow": true,
"isHide": false
},
{
"key": "WorkspaceAttrDetail",
"isShow": true,
"isHide": false
},
{
"key": "WorkspaceFieldsList",
"isShow": true,
"isHide": false
},
{
"key": "WorkspaceTagsList",
"isShow": true,
"isHide": false
},
{
"key": "WorkspaceEnvsList",
"isShow": true,
"isHide": false
},
{
"key": "WorkspaceMembers",
"isShow": true,
"isHide": false
},
{
"key": "WorkspaceRoles",
"isShow": true,
"isHide": false
},
{
"key": "APIManage",
"isShow": true,
"isHide": false
},
{
"key": "ClientToken",
"isShow": true,
"isHide": false
},
{
"key": "MemberInviteList",
"isShow": true,
"isHide": false
},
{
"key": "WorkspaceFilterRuleList",
"isShow": true,
"isHide": false
},
{
"key": "WorkspacePipelineList",
"isShow": true,
"isHide": false
},
{
"key": "LogBackupExplorer",
"isShow": true,
"isHide": false
},
{
"key": "DataAccessRuleList",
"isShow": true,
"isHide": false
},
{
"key": "RegexpList",
"isShow": true,
"isHide": false
},
{
"key": "KeyEventsAudit",
"isShow": true,
"isHide": false
},
{
"key": "EmbeddedSharing",
"isShow": true,
"isHide": false
},
{
"key": "CrossNamespacedataAuth",
"isShow": true,
"isHide": false
},
{
"key": "DataAuthorization",
"isShow": true,
"isHide": false
},
{
"key": "DataScanerList",
"isShow": true,
"isHide": false
},
{
"key": "WorkspaceCopilotSubscription",
"isShow": true,
"isHide": false
},
{
"key": "ErrorCenterList",
"isShow": true,
"isHide": false
},
{
"key": "Labs",
"isShow": true,
"isHide": false
}
]
},
{
"key": "Billing",
"isShow": true,
"isHide": false,
"children": []
}
],
"updated": true,
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427300,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正します。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の JSON ファイル形式エラー | 例に従ってオブジェクトを送信します。 |
| 400 | ft.ParamsValidateError | メニューノード/ロール設定が構造、識別子、型、サイズ、スコープ、または重複の制約に違反している | パラメータ検証失敗: {} | エラーの content.reason/path に基づいて特定し、最新のツリーとロール/リソースを読み取ってから修正します。 |
| 401 | ft.WKSPNotExistOrReleased | 現在のワークスペースが存在しない、またはアクティブ状態ではない | ワークスペースが存在しない/またはすでに解放済み | 現在のワークスペースが有効であることを確認し、対応するワークスペース Key を使用します。 |
| 500 | ft.InternalServerError | 設定の永続化または応答処理に失敗 | 内部エラー | 完全な設定を再読み取りして revision と結果を確認し、マージしてから保存して、同時変更の上書きを避けます。 |