콘텐츠로 이동

비로그 텍스트 데이터 스키마 정보 조회



GET /api/v1/metric_info/text_data/schema

개요

지정된 비로그 데이터 네임스페이스에서 당일 발견된 필드 이름과 데이터 유형을 조회합니다.

호출 전 및 사용 단계

조회 범위는 워크스페이스 시간대 기준 당일입니다. 조건에 맞는 데이터가 없으면 결과 필드는 해당 빈 배열입니다. 네임스페이스가 비어 있거나 지원되지 않는 경우 성공을 반환하며 content는 {}입니다. 로그 필드는 로그 스키마 조회를 호출하세요.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y AK 식별자로, 인증에 사용됩니다.
예시: <DF-API-KEY>
조회 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 본 인터페이스 권한이 있는 Key를 생성하거나 조회합니다.

Query 요청 파라미터

파라미터 이름 유형 필수 설명
namespace string Y 「lineage」, 「object」, 「object_history」, 「custom_object」, 「custom_object_history」, 「keyevent」, 「audit_event」, 「unrecovered_event」, 「tracing」, 「rum」, 「security」, 「network」, 「backup_log」, 「profiling」, 「rum_metric」, 「network_metric」, 「tracing_metric」, 「billing」, 「dialtest」, 「execution_log」, 「llm」, 「agent_monitor」, 「errorhub」를 지원합니다. 대소문자를 구분하지 않으며, 앞뒤 공백을 제거합니다.
null 허용: False
예시: tracing
조회 또는 입력 방법: 기록하는 데이터 유형에 따라 본 표에 나열된 네임스페이스 중에서 선택합니다.

파라미터 추가 설명

GET을 사용하여 현재 API Key가 속한 워크스페이스의 데이터를 읽습니다.

요청 예시

curl --get -H "DF-API-KEY: <DF-API-KEY>" \
  "https://openapi.guance.com/api/v1/metric_info/text_data/schema" \
  --data-urlencode "namespace=tracing"

응답

HTTP 200, application/json.

필드 유형 설명
content.namespace string 앞뒤 공백이 제거된 요청 네임스페이스입니다.
content.fields array<object> 결과 목록입니다. 일치하는 결과가 없으면 빈 배열입니다.
content.fields[].name string 필드 이름으로, 이후 조회에 사용할 수 있습니다.
content.fields[].value_type string 데이터 소스가 반환한 필드 값 유형이며, 빈 문자열일 수 있습니다.
content.fields[].type string 필드 분류로, 고정값은 text입니다.
content.fields[].description string 필드 설명으로, 현재 빈 문자열입니다.
content.declaration object 또는 null 워크스페이스 선언입니다. 응답에 이 공용 필드가 존재할 수 있으며, 자세한 내용은 공용 응답 구조를 참고하세요.
{"code": 200, "content": {"namespace": "tracing", "fields": [{"name": "service", "value_type": "string", "type": "text", "description": ""}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 필수 Query 파라미터가 누락되었거나 선언되지 않은 Query 파라미터가 전달됨 요청 필드 검증 실패이며, 메시지에 필드 또는 규칙이 명시됩니다. 파라미터 표와 예시를 확인하세요.
403 ft.ForbiddenQuery 현재 자격 증명이 요청에 해당하는 데이터를 조회할 권한이 없음 조회 권한이 부족합니다. API Key 조회 권한과 대상 데이터의 권한 부여 범위를 확인하세요.
503 ft.QueryServiceUnavailable 의존하는 조회 서비스를 일시적으로 사용할 수 없음 조회 서비스를 일시적으로 사용할 수 없으며, 잠시 후 다시 시도하세요. content.retryable을 확인하고, 일시적 오류인 경우 지연 후 재시도할 수 있습니다.

문서 평가

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