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

Prev Next

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

デプロイプロジェクトの実行履歴リストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
projectId String Required プロジェクト ID

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

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

フィールド タイプ 必須の有無 説明
pageNo Number Optional ページ番号
  • 1~N (デフォルト: 1)
pageSize Number Optional ページごとの項目数
  • 1~100 (デフォルト: 100)

リクエスト例

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

curl --location --request GET 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/history' \
--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.historyList Array - デプロイ履歴リスト

historyList

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

フィールド タイプ 必須の有無 説明
project Object - プロジェクト情報
project.id Number - プロジェクト ID
project.name String - プロジェクト名
stage Object - デプロイステージ情報
stage.id Number - デプロイステージ ID
stage.name String - デプロイステージ名
scenario Object - デプロイシナリオ情報
scenario.id Number - デプロイシナリオ ID
scenario.name String - デプロイシナリオ名
id String - ジョブ結果 ID
startTime Number - ジョブリクエスト日時
  • Unix Timestamp形式
status String - デプロイ状態

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

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

レスポンス例

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

{
    "result": {
        "historyList": [
            {
                "project": {
                    "id": 2***,
                    "name": "deploy2"
                },
                "stage": {
                    "id": 3***,
                    "name": "test"
                },
                "scenario": {
                    "id": 2***,
                    "name": "testscenario2"
                },
                "id": 80***,
                "startTime": 1747357650000,
                "status": "pending"
            },
            {
                "project": {
                    "id": 2***,
                    "name": "deploy2"
                },
                "stage": {
                    "id": 3***,
                    "name": "test"
                },
                "scenario": {
                    "id": 2***,
                    "name": "testscenario2"
                },
                "id": 80***,
                "startTime": 1747099665000,
                "status": "success"
            },
            {
                "project": {
                    "id": 2***,
                    "name": "deploy2"
                },
                "stage": {
                    "id": 3***,
                    "name": "test2"
                },
                "scenario": {
                    "id": 2***,
                    "name": "testsceneNKS"
                },
                "id": 80***,
                "startTime": 1747094733000,
                "status": "fail"
            },
            ...
        ]
    }
}