비로그 텍스트 데이터 Tags 정보 조회¶
GET /api/v1/metric_info/text_data/tags
개요¶
비로그 데이터 네임스페이스의 지정된 필드 값을 샘플링하여 조회합니다.
호출 전 및 사용 단계¶
조회 범위는 워크스페이스 시간대 기준 당일입니다. 조건에 맞는 데이터가 없으면 결과 필드는 해당하는 빈 배열입니다. 일부 비어 있지 않은 값만 반환되므로 모든 과거 값을 열거하는 데 사용할 수 없습니다. 업스트림 조회 결과의 null, 빈 문자열, 0 및 false는 샘플 목록에 포함되지 않습니다. 네임스페이스를 비워 두거나 지원되지 않는 경우, 또는 필드 이름을 비워 두는 경우에는 성공을 반환하고 content는 {}입니다.
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | AK 식별자로, 인증에 사용됩니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 이 API에 대한 권한이 있는 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가져오기 또는 입력 방법: 기록된 데이터 유형에 따라 이 표에 나열된 네임스페이스에서 선택합니다. |
| tag | string | Y | 샘플링할 값의 필드 이름입니다. null 허용: False 예시: service가져오기 또는 입력 방법: 동일한 네임스페이스의 비로그 텍스트 데이터 Schema 조회 응답에서 content.fields[].name을 가져옵니다. |
| limit | integer | 기본값은 10이며, 10보다 크면 10으로 처리합니다. 양의 정수를 전달하세요. null 허용: True 기본값: 10 예시: 10가져오기 또는 입력 방법: 호출자가 필요한 샘플 수에 따라 설정하며, 1~10을 권장합니다. |
매개변수 추가 설명¶
GET을 사용하여 현재 API Key가 속한 워크스페이스의 데이터를 조회합니다.
요청 예시¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/metric_info/text_data/tags" \
--data-urlencode "namespace=tracing" \
--data-urlencode "tag=service" \
--data-urlencode "limit=10"
응답¶
HTTP 200, application/json.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.namespace | string | 앞뒤 공백을 제거한 요청 네임스페이스입니다. |
| content.tag | string | 요청의 필드 또는 Tag 이름입니다. |
| content.values | array | 샘플링된 값입니다. 요소 유형은 데이터 소스 필드에 따라 달라지며, 일치하는 값이 없으면 빈 배열입니다. |
| content.declaration | object 또는 null | 워크스페이스 선언입니다. 응답에 이 공통 필드가 포함될 수 있으며, 자세한 내용은 공통 응답 구조를 참조하세요. |
{"code": 200, "content": {"namespace": "tracing", "tag": "service", "values": ["api", "worker"]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 필수 Query 매개변수가 누락되었거나 선언되지 않은 Query 매개변수가 전달되었습니다. | 요청 필드 검증에 실패했으며, 메시지에 필드 또는 규칙이 표시됩니다. | 매개변수 표와 예시를 확인하세요. |
| 403 | ft.ForbiddenQuery | 현재 자격 증명에 요청에 해당하는 데이터를 조회할 권한이 없습니다. | 조회 권한이 부족합니다. | API Key 조회 권한과 대상 데이터의 권한 부여 범위를 확인하세요. |
| 503 | ft.QueryServiceUnavailable | 의존하는 조회 서비스를 일시적으로 사용할 수 없습니다. | 조회 서비스를 일시적으로 사용할 수 없으므로 잠시 후 다시 시도하세요. | content.retryable을 확인하고, 일시적 오류인 경우 지연 후 다시 시도할 수 있습니다. |
| 500 | ft.InternalServerError | limit에 정수로 변환할 수 없는 문자열이 전달되었습니다. | 내부 오류입니다. | 매개변수 표를 통해 사용한 페이지네이션 필드를 확인하고, 십진 정수 문자열을 전달한 후 다시 시도하세요. |