기능 메뉴 조회 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이며, 부모-자식 조합이 ID를 결정합니다. |
| 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를 제공하여 관리자가 구성을 확인하도록 하십시오. 구성을 비워 손상을 숨기지 마십시오. |