Canary 분석 리포트 조회

Prev Next

VPC 환경에서 이용 가능합니다.

Canary 분석 리포트를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /api/v1/project/{projectId}/history/{historyId}/report/{endTime}

요청 헤더

SourceDeploy API에서 공통으로 사용하는 헤더에 대한 정보는 SourceDeploy 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
projectId String Required 프로젝트 아이디
historyId String Required 작업 결과 아이디
endTime String Required Canary 분석 완료 시간

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://vpcsourcedeploy.apigw.gov-ntruss.com/api/v1/project/1****/history/28****/report/1748333308000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
result Object - 응답 결과
result.status String - 분석 성공 여부
  • pass | fail
    • pass: 성공
    • fail: 실패
result.score Number - 총 점수
result.passScore Number - 분석 성공 점수
result.start Number - 분석 시작 일시
  • Unix Timestamp 형식
result.end Number - 분석 완료 일시
  • Unix Timestamp 형식
result.step Number - Metric 수집 주기(초)
result.metricList Array - Metric 목록

metricList

metricList에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
metricId Number - Metric 아이디
metricName String - Metric 이름
weight Number - Metric 가중치
elementList Array - Element 결과 정보

elementList

elementList에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
name String - Element 이름
element String - Element 값
deviation Number - Element 편차
status String - Element 결과
  • pass | fail
    • pass: 성공
    • fail: 실패
base Object - Baseline 쿼리 결과: 분석 정보
canary Object - Canary 쿼리 결과: 분석 정보

분석 정보

분석 정보에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
start Number - 분석 시작 일시
  • Unix Timestamp 형식
end Number - 분석 종료 일시
  • Unix Timestamp 형식
count Number - 수집 데이터 수
avg Number - 데이터 평균 값
max Number - 데이터 최댓값
min Number - 데이터 최솟값

응답 상태 코드

SourceDeploy API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 SourceDeploy 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "result": {
    "status": "pass",
    "score": 100,
    "passScore": 50,
    "start": 1748333248000,
    "end": 1748333308000,
    "step": 10,
    "metricList": [
      {
        "metricId": 239,
        "metricName": "metric1",
        "weight": 100,
        "elementList": [
          {
            "name": "#1",
            "element": "{\"__name__\":\"container_cpu_usage_seconds_total\",\"beta_kubernetes_io_arch\":\"amd64\",\"beta_kubernetes_io_instance_type\":\"SVR.VSVR.STAND.C002.M008.G003\"...\"regionNo\":\"1\",\"topology_kubernetes_io_region\":\"1\",\"topology_kubernetes_io_zone\":\"3\",\"zoneNo\":\"3\"}",
            "deviation": 0,
            "status": "pass",
            "base": {
              "start": 1748333248000,
              "end": 1748333308000,
              "count": 7,
              "avg": 0.010353,
              "max": 0.010353,
              "min": 0.010353
            },
            "canary": {
              "start": 1748333248000,
              "end": 1748333308000,
              "count": 7,
              "avg": 0.010353,
              "max": 0.010353,
              "min": 0.010353
            }
          },
          {
            "name": "#2",
            "element": "{\"__name__\":\"container_cpu_usage_seconds_total\",\"beta_kubernetes_io_arch\":\"amd64\",\"beta_kubernetes_io_instance_type\":\"SVR.VSVR.STAND.C002.M008.G003\"...\"regionNo\":\"1\",\"topology_kubernetes_io_region\":\"1\",\"topology_kubernetes_io_zone\":\"3\",\"zoneNo\":\"3\"}",
            "deviation": 0,
            "status": "pass",
            "base": {
              "start": 1748333248000,
              "end": 1748333308000,
              "count": 7,
              "avg": 0.008501,
              "max": 0.008501,
              "min": 0.008501
            },
            "canary": {
              "start": 1748333248000,
              "end": 1748333308000,
              "count": 7,
              "avg": 0.008501,
              "max": 0.008501,
              "min": 0.008501
            }
          },
          ...
        ]
      }
    ]
  }
}