機能メニューの取得 v2¶
GET /api/v1/workspace/menu_v2/get
概要¶
ワークスペースの2階層メニューの互換設定を読み取ります。
呼び出し前の準備と使用手順¶
routine.defaultAccess などの許可された権限を持つ、現在のワークスペース Key を使用します。ワークスペースのメニュー設定またはデフォルト投影を返します。現在の ID が最終的にアクセス可能なメニューではありません。可視性はページ/API/データの認可を代替できません。未保存の場合はメモリ内でのみサイトデフォルトを継承して変換し、設定は作成しません。v3 が存在する場合は互換投影を返します。システム/履歴互換メニューのみを含み、カスタムディレクトリとリソースは含まず、ロール別設定を完全には表現しません。
v2 は第1階層および第2階層の key/isShow/isHide を返します。ワークスペースの無効化とプラットフォームによる非表示は別々に表現され、isHide をワークスペース権限として書き戻すことはできません。新規ワークスペースのデフォルト値はサイト設定に依存し、例は固定の利用可能 Key の許可リストではありません。
Owner の ID で受け入れテストを行う際は注意が必要です。有効メニューの計算では、ワークスペースの isShow による非表示(区切り線を除く)は無視されますが、プラットフォームによる非表示と実際の権限の制約は引き続き受けます。通常のロールと Owner では最終的な表示が異なる場合があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/workspace/menu_v2/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
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 | 第1階層システムメニューの Key。そのまま返却され、動的ディレクトリとリソースはこの旧投影には含まれません。 |
| content.config[].isShow | boolean | ワークスペース設定で表示するかどうか。プラットフォームによる強制非表示や実際の権限を上書きしません。 |
| content.config[].isHide | boolean | プラットフォームによる強制非表示フラグ。表示するには isShow=true かつ isHide=false である必要があります。 |
| content.config[].children | array<object> |
第2階層システムメニューの配列。[] の場合があります。 |
| content.config[].children[].key | string | 第2階層メニューの 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": {
"workspaceUUID": "wksp_example",
"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": true,
"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": []
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | 設定の重複/形式破損、データベース読み取りまたはレスポンスのフォーマット失敗 | 内部エラー | traceId を提供して管理者が設定を確認できるようにしてください。設定をクリアして破損を隠さないでください。 |