カナリア分析リストの照会

Prev Next

VPC環境で利用できます。

カナリア分析レポートを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/project/{projectId}/history/{historyId}/report/{endTime}

リクエストヘッダ

SourceDeploy APIで共通して使用されるヘッダの詳細は、SourceDeployのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
projectId String Required プロジェクト ID
historyId String Required ジョブ結果 ID
endTime String Required カナリア分析完了時間

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
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 ID
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 - ベースラインクエリ結果: 分析情報
canary Object - カナリアクエリ結果: 分析情報

分析情報

分析情報の説明は次の通りです。

フィールド タイプ 必須の有無 説明
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
            }
          },
          ...
        ]
      }
    ]
  }
}