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

Prev Next

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

パイプラインの実行履歴リストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
projectId String Required パイプライン ID

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

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

フィールド タイプ 必須の有無 説明
pageNo Number Optional ページ番号
  • 1~N
  • pageSize入力時、必ず入力
pageSize Number Optional ページごとの項目数
  • 1~N
  • pageNo入力時、必ず入力

リクエスト例

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

curl --location --request GET 'https://vpcsourcepipeline.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の説明は次の通りです。

フィールド タイプ 必須の有無 説明
projectId Number - パイプライン ID
id Number - 実行タスク結果 ID
requestType String - 実行リクエストタイプ
  • console | trigger
    • console: ユーザーリクエスト
    • trigger: 予約トリガー
requestId String - 実行リクエスタ
begin Number - 実行リクエスト時間
  • Unix Timestamp形式
end Number - 実行終了時間
  • Unix Timestamp形式
status String - 実行状態

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

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

レスポンス例

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

{
    "result": {
        "historyList": [
            {
                "projectId": 2***,
                "id": 54***,
                "requestType": "console",
                "requestId": "*************",
                "begin": 1747038523000,
                "end": 1747038530000,
                "status": "success"
            }
        ]
    }
}