Get canary analysis report

Prev Next

Available in VPC

Get the canary analysis report.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/project/{projectId}/history/{historyId}/report/{endTime}

Request headers

For information about the headers common to all SourceDeploy APIs, see SourceDeploy request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
projectId String Required Project ID
historyId String Required Job result ID
endTime String Required Canary analysis completion time

Request example

The request example is as follows:

curl --location --request GET 'https://vpcsourcedeploy.apigw.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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result Object - Response result
result.status String - Analysis success status
  • pass | fail
    • pass: succeeded
    • fail: failed
result.score Number - Total score
result.passScore Number - Analysis success score
result.start Number - Analysis start date and time
  • Unix timestamp format
result.end Number - Analysis completion date and time
  • Unix timestamp format
result.step Number - Metric collection cycle (second)
result.metricList Array - Metric list

metricList

The following describes metricList.

Field Type Required Description
metricId Number - Metric ID
metricName String - Metric name
weight Number - Metric weight
elementList Array - Element result information

elementList

The following describes elementList.

Field Type Required Description
name String - Element name
element String - Element value
deviation Number - Element deviation
status String - Element result
  • pass | fail
    • pass: succeeded
    • fail: failed
base Object - Baseline query result: Analysis information
canary Object - Canary query result: Analysis information

Analysis information

The following describes the analysis information.

Field Type Required Description
start Number - Analysis start date and time
  • Unix timestamp format
end Number - Analysis end date and time
  • Unix timestamp format
count Number - Number of collected data
avg Number - Average value of data
max Number - Maximum value of data
min Number - Minimum value of data

Response status codes

For information about the HTTP status codes common to all SourceDeploy APIs, see SourceDeploy response status codes.

Response example

The response example is as follows:

{
  "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
            }
          },
          ...
        ]
      }
    ]
  }
}