콘텐츠로 이동

메저먼트 목록 조회, 검색 기능 지원



GET /api/v1/metric_info/measurement/list

개요

워크스페이스에서 당일 발견된 메저먼트를 나열합니다. 정규식을 사용하여 이름을 필터링할 수 있습니다.

호출 전 및 사용 단계

조회 범위는 워크스페이스 시간대 기준 당일입니다. 조건에 맞는 데이터가 없으면 결과 필드는 해당 빈 배열이 됩니다. 결과는 이름을 기준으로 대소문자를 구분하지 않고 정렬됩니다. 응답 결과에는 전체 건수가 없으므로, 이번 limit보다 적은 레코드를 수신하면 페이지네이션을 종료할 수 있습니다.

요청 헤더

매개변수명 유형 필수 설명
DF-API-KEY string Y AK 식별자, 인증에 사용됩니다
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 이 API 권한이 있는 Key를 생성하거나 가져옵니다.

Query 요청 매개변수

매개변수명 유형 필수 설명
search string 메저먼트 이름에 대해 정규식 매칭을 수행합니다. 예를 들어 ^cpu는 cpu로 시작하는 이름과 일치합니다. 생략하거나 비워 두면 범위에 맞는 모든 메저먼트를 반환합니다.
null 허용: True
예: ^cpu
가져오기 또는 입력 방법: 일치시킬 메저먼트 이름 또는 정규식을 사용합니다.
limit integer 기본값 100입니다. 양의 정수를 전달하세요.
null 허용: True
기본값: 100
예: 100
가져오기 또는 입력 방법: 클라이언트가 한 번에 읽고자 하는 레코드 수에 맞춰 입력하세요.
offset integer 몇 번째 레코드부터 읽을지 지정합니다. 0부터 계산하며 기본값은 0입니다.
null 허용: True
기본값: 0
예: 0
가져오기 또는 입력 방법: 첫 페이지에는 0을 전달합니다. 이후 페이지에서는 이전 offset에 limit을 더합니다.

매개변수 추가 설명

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

요청 예시

curl --get -H "DF-API-KEY: <DF-API-KEY>" \
  "https://openapi.guance.com/api/v1/metric_info/measurement/list" \
  --data-urlencode "search=^cpu" \
  --data-urlencode "limit=10" \
  --data-urlencode "offset=0"

응답

HTTP 200, application/json.

필드 유형 설명
content.data array<object> 결과 목록입니다. 일치하는 결과가 없으면 빈 배열입니다.
content.data[].name string 메저먼트의 정확한 이름입니다.
content.data[].type string 고정값은 metric입니다.
content.data[].description string 현재 빈 문자열입니다.
content.declaration object 또는 null 워크스페이스 선언입니다. 응답에 이 공통 필드가 포함될 수 있으며, 자세한 내용은 공통 응답 구조를 참조하세요.
{"code": 200, "content": {"data": [{"name": "cpu", "type": "metric", "description": ""}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 매개변수를 전달했습니다 요청 필드 검증에 실패했으며, 메시지에 필드 또는 규칙이 표시됩니다. 매개변수 표에 나열된 매개변수만 사용하세요.
403 ft.ForbiddenQuery 현재 자격 증명에 요청에 해당하는 데이터를 조회할 권한이 없습니다 조회 권한이 부족합니다. API Key의 조회 권한과 대상 데이터의 권한 부여 범위를 확인하세요.
503 ft.QueryServiceUnavailable 의존하는 조회 서비스를 일시적으로 사용할 수 없습니다 조회 서비스를 일시적으로 사용할 수 없으니 나중에 다시 시도하세요. content.retryable을 확인하고 일시적 오류인 경우 지연 후 다시 시도할 수 있습니다.
406 ft.DqlParseError 다운스트림에서 요청 매개변수로 구성된 쿼리를 파싱할 수 없습니다 DQL 쿼리 파싱 오류입니다. 상세 텍스트는 실제 표현식에 따라 달라집니다. 정규식 문법, 필드 및 인덱스 이름을 확인하세요. 가능하면 목록 또는 필드 API에서 값을 가져오세요.
500 ft.InternalServerError limit 또는 offset에 정수로 변환할 수 없는 문자열을 전달했습니다 내부 오류입니다. 매개변수 표를 통해 사용한 페이지네이션 필드를 확인하고, 십진 정수 문자열을 전달한 후 다시 시도하세요.

문서 평가

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