콘텐츠로 이동

기능 메뉴 설정



POST /api/v1/workspace/menu/set

개요

레거시 1차 프로토콜에 따라 워크스페이스 메뉴를 저장합니다.

호출 전 준비 및 사용 단계

workspace.setManage 권한이 있는 현재 워크스페이스 Key를 사용합니다. 레거시 프로토콜 호환 저장은 v3와 동일한 워크스페이스 트랜잭션 잠금을 거치며, 레거시 프로토콜로 표현 가능한 범위에서만 시스템 노드를 재배치하고 표시/숨김을 설정하면서 v3 사용자 정의 디렉터리/리소스/역할 설정은 유지합니다. 목록에 없는 레거시 노드는 기본 표시 상태로 복원되며, 배열의 한 항목만 수정하는 patch가 아닙니다. 따라서 먼저 전체 레거시 설정을 읽은 후 수정해야 합니다.

v1은 2차 메뉴 표시/숨김을 표현할 수 없으므로, 저장 시 과거 규칙에 따라 해당 범위의 레거시 2차 메뉴를 기본 표시 상태로 복원합니다. 새 클라이언트는 v3 사용을 권장합니다.

레거시 프로토콜은 expectedRevision을 요구하지 않으므로, 표현 가능한 범위 내에서 다른 편집자의 표시/숨김 수정을 덮어쓸 수 있습니다. 동시 편집 시에는 v3를 우선 사용하세요. 저장 결과는 (v1 쓰기 진입점을 포함한) 레거시 2단계 투영을 반환하며, 요청 형태에 맞춘 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 신서틱 모니터링
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 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": {
    "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과 결과를 확인하고, 병합한 후 저장하여 동시 수정 덮어쓰기를 방지하세요.

문서 평가

이 페이지가 도움이 되었나요?