シナリオデプロイ履歴の照会

Classic/VPC環境で利用できます。

デプロイプロジェクト実行履歴の詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`projectId`	String	Required	プロジェクト ID プロジェクトリストの照会を参照
`historyId`	String	Required	ジョブ結果 ID シナリオデプロイ履歴リストの照会を参照

リクエスト例

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

curl --location --request GET 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/history/80***' \
--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.project`	Object	-	プロジェクト情報
`result.project.id`	Number	-	プロジェクト ID
`result.project.name`	String	-	プロジェクト名
`result.stage`	Object	-	デプロイステージ情報
`result.stage.id`	Number	-	デプロイステージ ID
`result.stage.name`	String	-	デプロイステージ名
`result.scenario`	Object	-	デプロイシナリオ情報
`result.scenario.id`	Number	-	デプロイシナリオ ID
`result.scenario.name`	String	-	デプロイシナリオ名
`result.id`	Number	-	ジョブ結果 ID
`result.status`	String	-	デプロイの状態 `success` \| `fail` \| `inprogress` \| `pending` \| `reject` \| `canceling` \| `canceled` \| `waiting` \| `error` \| `canary_pending` \| `canary_reject` \| `canary_analyzing` \| `canary_waiting_timeout` \| `canary_rejecting` `success`: デプロイ完了 `fail`: デプロイ失敗 `inprogress`: デプロイ中 `pending`: デプロイ承認待ち `reject`: デプロイ承認を拒否 `canceling`: デプロイをキャンセル中 `canceled`: デプロイキャンセル完了 `waiting`: デプロイ待ち `error`: エラー `canary_pending`: カナリアデプロイ待ち `canary_reject`: カナリアデプロイをキャンセル `canary_analyzing`: カナリア分析中 `canary_waiting_timeout`: カナリア分析タイムアウト `canary_rejecting`: カナリアデプロイキャンセル中
`result.executor`	String	-	デプロイリクエスタ
`result.startTime`	Number	-	デプロイリクエスト日時 Unix Timestamp形式
`result.endTime`	Number	-	デプロイ終了日時 Unix Timestamp形式
`result.type`	String	-	デプロイターゲットタイプ `Server` \| `AutoScalingGroup` \| `KubernetesService` \| `ObjectStorage`
`result.config`	Object	-	デプロイターゲットの設定 Server: THistoryServerを参照 AutoScalingGroup: THistoryAutoScalingを参照 KubernetesService: THistoryKubernetesServiceを参照 ObjectStorage: THistoryObjectStorageを参照

THistoryServer

THistoryServerの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`strategy`	String	-	デプロイ戦略 `normal`: 基本 (有効値)
`targets`	Array	-	デプロイ進行情報
`file`	Object	-	デプロイファイル情報
`file.selected`	String	-	デプロイファイル
`file.type`	String	-	デプロイファイルタイプ

`targets`

targetsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`server`	Object	-	対象サーバ情報
`server.no`	Number	-	対象サーバ番号
`server.name`	String	-	対象サーバ名
`status`	String	-	デプロイの状態 `pending` \| `standby` \| `pre` \| `deploy` \| `post` \| `success` \| `fail` \| `no progress` `pending`: エージェントからのレスポンス待ち `standby`: エージェント接続完了 `pre`: デプロイ前実行を進行中 `deploy`: ファイルデプロイ進行中 `post`: デプロイ後実行を進行中 `success`: デプロイ完了 `fail`: デプロイ失敗 `no progress`: デプロイを行わない
`time`	Object	-	段階別日時
`time.pre`	Number	-	デプロイ前の実行日時 Unix Timestamp形式
`time.deploy`	Number	-	ファイルデプロイ日時 Unix Timestamp形式
`time.post`	Number	-	デプロイ後の実行日時 Unix Timestamp形式
`step`	Object	-	段階別状態
`step.pre`	String	-	デプロイ前の実行状態 `success` \| `fail` \| `inprogress` `success`: 完了 `fail`: 失敗 `inprogress`: 進行中
`step.deploy`	String	-	ファイルデプロイの状態 `success` \| `fail` \| `inprogress` `success`: 完了 `fail`: 失敗 `inprogress`: デプロイ中
`step.post`	String	-	デプロイ後の実行状態 `success` \| `fail` \| `inprogress` `success`: 完了 `fail`: 失敗 `inprogress`: 進行中

THistoryAutoScaling

THistoryAutoScalingの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`strategy`	String	-	デプロイ戦略 `normal` \| `blueGreen` `normal`: 基本 `blueGreen`: ブルー/グリーン
`autoScalingGroup`	Object	-	Auto Scalingグループ情報
`autoScalingGroup.no`	Number	-	Auto Scalingグループ番号
`autoScalingGroup.name`	String	-	Auto Scalingグループ名
`targets`	Array	-	デプロイ進行情報
`file`	Object	-	デプロイファイル情報
`file.selected`	String	-	デプロイファイル
`file.type`	String	-	デプロイファイルタイプ

`targets`

targetsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`server`	Object	-	対象サーバ情報
`server.no`	Number	-	対象サーバ番号
`server.name`	String	-	対象サーバ名
`status`	String	-	デプロイの状態 `pending` \| `standby` \| `pre` \| `deploy` \| `post` \| `success` \| `fail` \| `no progress` `pending`: エージェントからのレスポンス待ち `standby`: エージェント接続完了 `pre`: デプロイ前実行を進行中 `deploy`: ファイルデプロイ進行中 `post`: デプロイ後実行を進行中 `success`: デプロイ完了 `fail`: デプロイ失敗 `no progress`: デプロイを行わない
`time`	Object	-	段階別日時
`time.pre`	Number	-	デプロイ前の実行日時 Unix Timestamp形式
`time.deploy`	Number	-	ファイルデプロイ日時 Unix Timestamp形式
`time.post`	Number	-	デプロイ後の実行日時 Unix Timestamp形式
`step`	Object	-	段階別状態
`step.pre`	String	-	デプロイ前の実行状態 `success` \| `fail` \| `inprogress` `success`: 完了 `fail`: 失敗 `inprogress`: 進行中
`step.deploy`	String	-	ファイルデプロイの状態 `success` \| `fail` \| `inprogress` `success`: 完了 `fail`: 失敗 `inprogress`: デプロイ中
`step.post`	String	-	デプロイ後の実行状態 `success` \| `fail` \| `inprogress` `success`: 完了 `fail`: 失敗 `inprogress`: 進行中

THistoryKubernetesService

THistoryKubernetesServiceの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`strategy`	String	-	デプロイ戦略 `rolling` \| `blueGreen` \| `canary` `rolling`: Rolling `blueGreen`: ブルー/グリーン `canary`: カナリア
`targets`	Object	-	デプロイ進行情報
`targets.time`	Object	-	段階別日時
`targets.time.pre`	Number	-	デプロイ準備日時 Unix Timestamp形式
`targets.time.deploy`	Number	-	デプロイ日時 Unix Timestamp形式
`targets.step`	Object	-	段階別状態
`targets.step.pre`	String	-	デプロイ準備状態 `success` \| `fail` \| `inprogress` `success`: 完了 `fail`: 失敗 `inprogress`: 進行中
`targets.step.deploy`	String	-	デプロイの状態 `success` \| `fail` \| `inprogress` `success`: 完了 `fail`: 失敗 `inprogress`: デプロイ中

THistoryObjectStorage

THistoryObjectStorageの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`file`	Object	-	デプロイファイル情報
`file.selected`	String	-	デプロイファイル
`file.type`	String	-	デプロイファイルタイプ
`targets`	Object	-	デプロイ進行情報
`targets.time`	Object	-	段階別日時
`targets.time.pre`	Number	-	デプロイ準備日時 Unix Timestamp形式
`targets.time.deploy`	Number	-	デプロイ日時 Unix Timestamp形式
`targets.step`	Object	-	段階別状態
`targets.step.pre`	String	-	デプロイ準備状態 `success` \| `fail` \| `inprogress` `success`: 完了 `fail`: 失敗 `inprogress`: 進行中
`targets.step.deploy`	String	-	デプロイの状態 `success` \| `fail` \| `inprogress` `success`: 完了 `fail`: 失敗 `inprogress`: デプロイ中
`backupFile`	String	-	バックアップファイルのパスデプロイ時にバックアップ使用を設定した場合、表示

レスポンスステータスコード

SourceDeploy APIで共通して使用されるレスポンスステータスコードの詳細は、SourceDeployのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "result": {
        "project": {
            "id": 2***,
            "name": "deploy3"
        },
        "stage": {
            "id": 3***,
            "name": "dev-ob"
        },
        "scenario": {
            "id": 2***,
            "name": "testscenario"
        },
        "id": 80***,
        "status": "success",
        "executor": "by schedule trigger",
        "startTime": 1747231215000,
        "endTime": 1747231215000,
        "type": "ObjectStorage",
        "config": {
            "file": {
                "selected": "devtool/sourcebuild_backup/bb5a5880-****-****-****-8d4f9ac76620/build-sample.zip",
                "type": "storage"
            },
            "targets": {
                "time": {
                    "pre": 1747231215000,
                    "deploy": 1747231215000
                },
                "step": {
                    "pre": "success",
                    "deploy": "success"
                }
            }
        }
    }
}