パイプライン実行履歴の照会

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

パイプライン実行履歴の詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`projectId`	String	Required	パイプライン ID パイプラインリストの照会を参照
`historyId`	String	Required	実行タスク結果 ID 実行履歴リストの照会を参照

リクエスト例

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

curl --location --request GET 'https://vpcsourcepipeline.apigw.ntruss.com/api/v1/project/2***/history/54***' \
--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.history`	Object	-	実行履歴情報
`result.history.id`	Number	-	実行タスク結果 ID
`result.history.projectId`	Number	-	パイプライン ID
`result.history.begin`	Number	-	実行リクエスト時間 Unix Timestamp形式
`result.history.end`	Number	-	実行終了時間 Unix Timestamp形式
`result.history.status`	String	-	実行状態
`result.history.tasks`	Array	-	タスク別履歴リスト

`tasks`

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

フィールド	タイプ	必須の有無	説明
`id`	Number	-	タスク ID
`name`	String	-	タスク名
`type`	String	-	タスクタイプ `SourceBuild` \| `SourceDeploy`
`linkedTasks`	Array	-	先行タスクリスト
`status`	String	-	タスクの実行時間
`resultId`	String	-	ジョブ結果 ID
`config`	Object	-	タスク設定情報
`config.projectId`	Number	-	タスクプロジェクト ID
`config.stageId`	Number	-	デプロイステージ ID `type`が`SourceDeploy`の場合、表示
`config.scenarioId`	Number	-	デプロイシナリオ ID `type`が`SourceDeploy`の場合、表示
`config.target`	Object	-	接続情報
`config.target.type`	String	-	接続タイプ `SourceCommit` \| `GitHub` \| `Bitbucket` \| `Github Enterprise Server` \| `SourceBuild` \| `ObjectStorage` \| `KubernetesService`
`config.target.name`	String	-	接続プロジェクト名 `type`が`SourceBuild`の場合、表示
`config.target.info`	Object	-	詳細な接続情報
`config.target.info.repository`	String	-	リポジトリ名 `type`が`SourceBuild`の場合、表示
`config.target.info.branch`	String	-	ブランチ名 `type`が`SourceBuild`の場合、表示
`config.target.info.workspace`	Object	-	Bitbucketワークスペース情報 `config.target.type`が`Bitbucket`の場合、下位情報を含めて表示
`config.target.info.workspace.id`	String	-	Bitbucketワークスペース ID
`config.target.info.workspace.name`	String	-	Bitbucketワークスペース名
`config.target.info.authType`	String	-	Github Enterprise Serverログインタイプ `config.target.type`が`Github Enterprise Server`の場合、表示
`config.target.info.url`	String	-	Gitリポジトリ URL `config.target.type`が`Github Enterprise Server`で、`config.target.info.authType`が`ssh`の場合、表示
`config.target.info.serverUrl`	String	-	サーバ URL `config.target.type`が`Github Enterprise Server`で、`config.target.info.authType`が`OAuth`、`Personal Access Token`、`Username/Password`の場合、表示
`config.target.info.owner`	String	-	Github Enterprise Serverの所有者 `config.target.type`が`Github Enterprise Server`の場合、表示
`config.target.info.projectName`	String	-	ビルドプロジェクト名 `config.target.type`が`SourceBuild`の場合、表示
`config.target.info.file`	String	-	Object Storage内のファイルの保存場所 `config.target.type`が`ObjectStorage`の場合、表示
`config.target.info.storageType`	String	-	マニフェストファイルの保存場所 `config.target.type`が`KubernetesService`の場合、表示
`config.target.info.repository`	String	-	マニフェストファイルの保存先のリポジトリ `config.target.info.storageType`が`SourceCommit`の場合、表示
`config.target.info.branch`	String	-	マニフェストファイルの保存先のリポジトリのブランチ `config.target.info.storageType`が`SourceCommit`の場合、表示
`config.target.info.manifest`	String	-	マニフェストファイル `config.target.type`が`KubernetesService`の場合、表示
`config.target.info.fullManifest`	String	-	マニフェストファイルリスト `config.target.type`が`KubernetesService`の場合、表示

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

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

レスポンス例

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

{
    "result": {
        "history": {
            "id": 54***,
            "projectId": 2***,
            "begin": 1747205286000,
            "end": 1747205302000,
            "status": "success",
            "tasks": [
                {
                    "id": 6***,
                    "name": "task1",
                    "type": "SourceBuild",
                    "linkedTasks": [],
                    "status": "success",
                    "resultId": "65f88dd0-****-****-****-7f4c5f58b640",
                    "config": {
                        "projectId": 20***,
                        "target": {
                            "type": "SourceCommit",
                            "name": "build-sample",
                            "info": {
                                "repository": "rep-sample",
                                "branch": "master"
                            }
                        }
                    }
                },
                {
                    "id": 6***,
                    "name": "task2",
                    "type": "SourceDeploy",
                    "linkedTasks": [
                        "task1"
                    ],
                    "status": "success",
                    "resultId": "80***",
                    "config": {
                        "projectId": 2***,
                        "stageId": 3***,
                        "scenarioId": 2***,
                        "target": {
                            "type": "SourceBuild",
                            "info": {
                                "projectName": "build-sample"
                            }
                        }
                    }
                }
            ]
        }
    }
}