콘텐츠로 이동

현재 워크스페이스 정보 조회



GET /api/v1/workspace/get

개요

현재 API Key가 속한 워크스페이스의 기본 정보를 조회합니다.

호출 전 준비 및 사용 단계

요청에는 워크스페이스 UUID나 Query 파라미터가 필요하지 않습니다. 응답의 uuid에서 호출 주체에 해당하는 워크스페이스를 확인합니다. 워크스페이스 설정은 짧은 시간 동안 캐시를 사용할 수 있으며, 응답의 serverTime은 서버 시간입니다. 아래 필드와 예시는 자주 사용하는 필드만 발췌한 것이며, 응답의 워크스페이스 자격 증명과 서비스 설정은 민감 정보로 처리해야 합니다.

사이트 도메인 표에서 해당 사이트의 OpenAPI 주소를 선택합니다.

요청 헤더

파라미터 이름 타입 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI Key 자격 증명입니다. 전체 키 값을 사용하며 API Key 레코드의 UUID는 사용하지 않습니다.
예시: <DF-API-KEY>
발급 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 본 인터페이스 권한을 가진 Key를 생성하거나 확인합니다.

파라미터 추가 설명

워크스페이스는 요청의 DF-API-KEY로 결정됩니다.

요청 예시

curl --get -H "DF-API-KEY: <DF-API-KEY>" \
  "https://openapi.guance.com/api/v1/workspace/get"

응답

HTTP 200, application/json.

필드 타입 설명
content.uuid string 워크스페이스 UUID입니다. 이후 인터페이스의 workspace_uuid 경로 또는 workspaceUUID 요청 필드에 사용합니다.
content.name string 워크스페이스 표시 이름입니다.
content.desc string 워크스페이스 설명입니다.
content.status integer 워크스페이스 상태입니다.
content.timezone string 워크스페이스 시간대입니다. 예: Asia/Shanghai.
content.language string 워크스페이스 언어 설정입니다.
content.versionType string 워크스페이스 버전 유형입니다.
content.regionCode string 사이트 식별자입니다.
content.memberCount integer 워크스페이스 및 연결된 팀 구성원 수의 합계입니다.
content.note string 현재 호출 주체의 워크스페이스 내 비고입니다.
content.logoUrl string 워크스페이스 Logo URL이며 비어 있을 수 있습니다.
content.faviconUrl string 워크스페이스 아이콘 URL이며 비어 있을 수 있습니다.
content.serverTime integer 해당 응답 생성 시점의 서버 Unix 시간으로, 단위는 밀리초입니다. 캐시가 적중하면 이전 값을 재사용합니다.
content.datastore object 워크스페이스의 데이터 스토리지 설정입니다.
content.durationSet object 워크스페이스의 데이터 유형별 보존 설정입니다.
content.leftWildcard boolean 좌측 와일드카드 쿼리 활성화 여부입니다.
content.logMultipleIndexCount integer 워크스페이스의 로그 다중 인덱스 수 설정입니다.
content.durationUpdatedToday boolean 오늘 보존 설정을 수정한 경우 true이며, 조건을 충족할 때만 표시됩니다.
content.declaration object 또는 null 워크스페이스의 공개 선언 정보입니다.
content.token string 워크스페이스의 데이터 쓰기 자격 증명입니다. workspace.tokenRead가 없으면 권한 마스크로 처리되며, 응답의 값은 비밀로 유지해야 합니다.
{
  "code": 200,
  "content": {
    "uuid": "wksp_example",
    "name": "프로덕션 모니터링",
    "desc": "프로덕션 서비스 관측",
    "status": 0,
    "timezone": "Asia/Shanghai",
    "language": "zh",
    "versionType": "pay",
    "regionCode": "console",
    "memberCount": 3,
    "note": "",
    "logoUrl": "",
    "faviconUrl": "",
    "serverTime": 1785456000000
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.NotFoundWorkspace API Key에 해당하는 워크스페이스가 존재하지 않거나 사용할 수 없음 워크스페이스가 존재하지 않습니다. API Key 및 해당 워크스페이스 상태를 확인합니다.

문서 평가

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