목록 조회¶
GET /api/v1/service_manage/performance/list
개요¶
시간 범위를 기준으로 현재 API Key가 속한 워크스페이스의 서비스 성능 통계를 나열합니다.
호출 전 및 사용 단계¶
먼저 조회 범위를 정하고 service 필드와 수집 태그로 필터 조건을 구성합니다. 기본적으로 p99 내림차순으로 정렬하며 현재 호출자가 즐겨찾기한 서비스를 앞에 배치합니다. order를 명시하면 해당 정렬 기준으로 페이지를 나눕니다. 기본값은 pageIndex=1, pageSize=50입니다. content.pageInfo.totalCount와 현재 페이지 수량을 기준으로 계속 조회할지 판단합니다. content.buckets[].service를 사용하여 서비스 성능 상세를 요청합니다. 반환되는 max_* 값은 해당 범위의 전체 서비스를 기준으로 하며, filters를 추가한 후에도 이러한 전역 비교 상한은 유지됩니다. 인덱스나 통계 데이터가 없으면 max_*는 생략될 수 있습니다. loading=true는 추가 서비스 상태가 아직 로드 중일 수 있음을 의미하며, 잠시 후 다시 요청할 수 있습니다.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| end | integer | Y | 조회 종료 시간, Unix 밀리초. start와 동일한 시간 기준을 사용합니다. 예시: 1785430800000가져오기 또는 입력 방법: 조회 종료 시점의 Unix 밀리초 정수를 사용합니다. 예: JavaScript Date.getTime() 결과. |
| filters | json | 필터 JSON. tags 배열을 포함한 객체 또는 조건 배열을 사용할 수 있습니다. name은 수집 필드이며 예: service, env 또는 version입니다. operation 또는 호환 op는 연산을 지정하고, value는 배열입니다. condition 또는 호환 logic은 and/or를 지정하며 기본값은 and입니다. 하위 filters 배열은 중첩 조건을 구성합니다. 예시: {"tags": [{"name": "service", "operation": "in", "value": ["checkout-api"], "condition": "and"}]}가져오기 또는 입력 방법: 서비스 성능 목록 반환 항목에서 서비스 이름, 환경 및 버전을 선택하거나 실제 수집 태그 필드를 사용합니다. JSON 문자열은 --data-urlencode로 전달합니다. |
|
| order | string | 기본값은 p99 내림차순입니다. 허용 필드: key, total_count, avg_resp_time, avg_per_second, error_count, error_rate, sum_resp_time, max_duration, p50, p75, p90, p95, p99. 배열의 첫 번째 객체만 사용합니다. 예시: [{"p99":"desc"}]가져오기 또는 입력 방법: 허용 필드 중 하나를 선택하고 필요에 따라 asc 또는 desc를 선택합니다. 단일 요소 JSON 배열 문자열로 전달합니다. |
|
| pageIndex | integer | 페이지 번호, 기본값 1. null 허용: False $minValue: 1 예시: 1가져오기 또는 입력 방법: 1부터 시작하고 이후 요청에서 페이지 번호를 증가시키며 필터와 시간 범위를 일관되게 유지합니다. |
|
| pageSize | integer | 페이지당 수량, 기본값 50. null 허용: False $maxValue: 100 $minValue: 1 예시: 50가져오기 또는 입력 방법: 필요에 따라 1~100 사이의 정수를 입력합니다. |
|
| start | integer | Y | 조회 시작 시간, Unix 밀리초. end와 함께 실제 필요한 통계 범위를 구성하는 것이 좋습니다. 예시: 1785427200000가져오기 또는 입력 방법: 콘솔 시간 선택기 또는 업무 기록에 따라 조회 시작 시점을 가져와 Unix 밀리초 정수로 변환합니다. 예시 시간은 자신의 조회 범위로 바꿔야 합니다. |
파라미터 추가 설명¶
filters 예시는 원시 JSON 구조로 전달하고 URL 인코딩합니다. order는 비어 있지 않은 JSON 배열이어야 하며 첫 번째 항목이 정렬 객체여야 합니다. 잘못된 형태이거나 name, operation 또는 value가 누락된 필터 항목은 일반 내부 오류를 유발할 수 있습니다. 요청 전에 위 구조에 맞게 구성하십시오.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/service_manage/performance/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode start=1785427200000 \
--data-urlencode end=1785430800000 \
--data-urlencode 'filters={"tags":[{"name":"service","operation":"in","value":["checkout-api"],"condition":"and"}]}' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=50
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.max_duration | number | 모든 서비스의 최대 응답 시간 상한, 마이크로초. |
| content.max_total_count | integer | 모든 서비스 중 최대 총 요청 수입니다. |
| content.max_per_second | number | 모든 서비스 중 최대 초당 요청 수입니다. 단위: req/s. |
| content.max_avg_duration | number | 모든 서비스 중 최대 평균 응답 시간입니다. 단위: 마이크로초. |
| content.max_sum_duration | number | 모든 서비스 중 최대 누적 응답 시간입니다. 단위: 마이크로초. |
| content.max_p50 | number | 모든 서비스 중 최대 P50 응답 시간입니다. 단위: 마이크로초. |
| content.max_p75 | number | 모든 서비스 중 최대 P75 응답 시간입니다. 단위: 마이크로초. |
| content.max_p90 | number | 모든 서비스 중 최대 P90 응답 시간입니다. 단위: 마이크로초. |
| content.max_p95 | number | 모든 서비스 중 최대 P95 응답 시간입니다. 단위: 마이크로초. |
| content.max_p99 | number | 모든 서비스 중 최대 P99 응답 시간입니다. 단위: 마이크로초. |
| content.buckets | array<object> |
현재 페이지의 서비스 통계입니다. 통계 필드는 사용 가능한 데이터에 따라 제공됩니다. |
| content.buckets[].key | string | 그룹화된 서비스 이름이며 일반적으로 service와 동일합니다. |
| content.buckets[].service | string | 수집 데이터의 서비스 이름이며 단일 서비스 조회의 serviceName이기도 합니다. |
| content.buckets[].source_type | string | 수집된 서비스 소스 유형입니다. |
| content.buckets[].type | string | 호환 필드이며 source_type과 동일합니다. |
| content.buckets[].version | string | 서비스 버전이며 해당 통계 차원이 존재할 때 반환됩니다. |
| content.buckets[].env | string | 서비스 환경이며 해당 통계 차원이 존재할 때 반환됩니다. |
| content.buckets[].total_count | integer | 통계 범위의 요청 수입니다. |
| content.buckets[].avg_per_second | number | 평균 초당 요청 수이며 단위는 req/s입니다. |
| content.buckets[].avg_resp_time | number | 평균 응답 시간이며 단위는 마이크로초입니다. 밀리초로 변환하려면 1000으로 나눕니다. |
| content.buckets[].sum_resp_time | number | 누적 요청 응답 시간이며 단위는 마이크로초입니다. |
| content.buckets[].max_duration | number | 최대 요청 응답 시간이며 단위는 마이크로초입니다. |
| content.buckets[].p50 | number | 응답 시간의 50번째 백분위수이며 단위는 마이크로초입니다. |
| content.buckets[].p75 | number | 응답 시간의 75번째 백분위수이며 단위는 마이크로초입니다. |
| content.buckets[].p90 | number | 응답 시간의 90번째 백분위수이며 단위는 마이크로초입니다. |
| content.buckets[].p95 | number | 응답 시간의 95번째 백분위수이며 단위는 마이크로초입니다. |
| content.buckets[].p99 | number | 응답 시간의 99번째 백분위수이며 단위는 마이크로초입니다. |
| content.buckets[].error_count | integer | 오류 요청 수입니다. |
| content.buckets[].error_rate | number | 오류율이며 0~1입니다. 백분율로 표시하려면 100을 곱합니다. |
| content.buckets[].apdex | number 또는 string | 백엔드에서 제공하는 경우 반환되는 Apdex 만족도입니다. |
| content.buckets[].serviceCatelog | object | 등록된 서비스의 TOML 서비스 구성이 변환된 객체입니다. 철자는 serviceCatelog로 유지합니다. 구조는 서비스 구성 생성의 serviceCatelog TOML 문자열을 파싱한 후의 구조와 동일합니다. 생성 파라미터는 여전히 TOML 문자열이며, 필드 의미와 입력 출처는 해당 페이지를 참조하십시오. 등록되지 않은 경우 빈 객체입니다. |
| content.buckets[].serviceCatelog.Team.team | string | 구성이 존재하는 경우 담당 팀 이름입니다. 기타 서비스 구성 필드는 서비스 구성 상세 정보와 함께 확인할 수 있습니다. |
| content.buckets[].checkerInfo | array<object> |
연결된 모니터 목록입니다. |
| content.buckets[].checkerInfo[].name | string | 모니터 이름입니다. |
| content.buckets[].checkerInfo[].uuid | string | 모니터 UUID입니다. |
| content.buckets[].checkerInfo[].type | string | 모니터 유형입니다. |
| content.buckets[].dfStatus | string | 서비스의 현재 이벤트 상태이며 예: ok, critical입니다. 상태 기록이 없으면 ok입니다. |
| content.buckets[].__docid | string | 서비스 상태에 해당하는 이벤트 문서 ID이며, 대응하는 이벤트가 없으면 빈 문자열입니다. |
| content.buckets[].isFavorite | integer 또는 null | 현재 호출자의 즐겨찾기 표시입니다. 등록된 서비스는 0 또는 1이며, 대응하는 서비스 구성이 없으면 null일 수 있습니다. |
| content.buckets[].uuid | string | 등록된 서비스 구성 UUID입니다. 등록되지 않은 서비스는 빈 문자열일 수 있습니다. |
| content.buckets[].language | string | 등록된 수집 SDK 언어이며, 등록되지 않은 경우 비어 있을 수 있습니다. |
| content.pageInfo | object | 페이지 정보는 content 내에 있습니다. |
| content.pageInfo.pageIndex | integer | 현재 페이지 번호입니다. |
| content.pageInfo.pageSize | integer | 페이지당 수량입니다. |
| content.pageInfo.count | integer | 현재 페이지의 실제 수량입니다. |
| content.pageInfo.totalCount | integer | 일치하는 서비스 총수입니다. |
| content.loading | boolean | 추가 상태가 여전히 비동기 로드 중인지 여부입니다. |
| content.declaration | object 또는 null | 워크스페이스 공통 선언입니다. |
{
"code": 200,
"content": {
"max_duration": 150000,
"max_total_count": 1200,
"max_per_second": 0.333333,
"max_avg_duration": 25000,
"max_sum_duration": 30000000,
"max_p50": 18000,
"max_p75": 25000,
"max_p90": 45000,
"max_p95": 70000,
"max_p99": 120000,
"buckets": [
{
"key": "checkout-api",
"service": "checkout-api",
"source_type": "web",
"type": "web",
"version": "1.0.0",
"env": "production",
"total_count": 1200,
"avg_per_second": 0.333333,
"avg_resp_time": 25000,
"sum_resp_time": 30000000,
"max_duration": 150000,
"p50": 18000,
"p75": 25000,
"p90": 45000,
"p95": 70000,
"p99": 120000,
"error_count": 12,
"error_rate": 0.01,
"serviceCatelog": {},
"checkerInfo": [],
"dfStatus": "ok",
"__docid": "",
"isFavorite": 0,
"uuid": "sman_example",
"language": "python"
}
],
"pageInfo": {
"pageIndex": 1,
"pageSize": 50,
"count": 1,
"totalCount": 1
},
"loading": false,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
일치하는 트레이스 데이터가 없으면 목록은 빈 buckets를 반환하고 단일 서비스는 빈 객체를 반환하며, 일반적으로 "서비스가 존재하지 않음" 오류는 반환하지 않습니다. 백엔드에서 반환하는 기타 4xx 조회 오류는 실제 errorCode와 message에 따라 반환됩니다.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방식 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드 누락 또는 필드 값이 선언된 검증 조건을 위반함 | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 유형 및 값을 확인합니다. |
| 422 | ft.KodoAPMSummaryRowBudgetExceeded | 서비스 통계 집계 스캔 예산 초과 | APM 서비스 요약 데이터 양이 처리 상한을 초과했습니다. 시간 범위를 줄인 후 다시 시도하십시오. | 시간 범위를 줄입니다. pageSize를 줄여도 전체 서비스 집계 예산은 감소하지 않습니다. |
| 429 | ft.KodoServerOverloaded | 조회 서비스가 과부하되었거나 혼잡함 | 현재 요청이 너무 빈번합니다. 잠시 후 다시 시도하십시오. | 백오프 간격으로 재시도하고 동시 조회 수를 줄입니다. |
| 500 | ft.InternalServerError | 통계 서비스 사용 불가, 연결 시간 초과 또는 기타 내부 조회 예외가 전달되지 않음 | 내부 오류 | 잠시 후 다시 시도하거나 시간 범위를 줄입니다. 지속적으로 실패하면 traceId와 요청 파라미터를 제공하십시오. |
| 406 | ft.KodoRequestDeadlineExceeded | 조회 실행 시간이 백엔드에서 허용된 시간을 초과함 | 데이터 조회 시간이 초과되었습니다. 원인은 다음과 같을 수 있습니다: 데이터 양이 너무 많음, 네트워크 지연, 서버 부하 과다. 다음 방법으로 이 문제를 해결할 수 있습니다: 1. 필터 조건을 추가하거나 시간 범위를 줄인 후 다시 조회합니다. 2. 잠시 기다린 후 다시 조회를 시도합니다. |
시간 범위를 줄이고 필터 조건을 추가한 후 다시 시도합니다. |
| 406 | ft.KodoTooManyRows | 조회 데이터 양이 백엔드 제한을 초과함 | 조회한 데이터 양이 최대 수량 제한을 초과했습니다. 필터 조건을 추가하거나 시간 범위를 줄인 후 다시 조회하십시오. | 시간 범위를 줄이거나 일치하는 서비스를 줄인 후 다시 시도합니다. |
| 406 | ft.KodoInvalidRegexPattern | 사용한 정규식 필터 표현식이 유효하지 않음 | 제공된 정규식 패턴이 유효하지 않습니다 | 정규식을 수정하거나 명확한 서비스 이름 집합을 사용합니다. |