ビルド履歴の照会

Prev Next

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

SourceBuildプロジェクトのビルド履歴を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://sourcebuild.apigw.ntruss.com/api/v1/project/20***/history' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
result Object - レスポンス結果
result.total Number - レスポンス結果数
result.history Array - ビルド履歴リスト
  • ビルド履歴がない場合、空の値[]を表示

history

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

フィールド タイプ 必須の有無 説明
projectId Number - プロジェクト ID
buildId String - ビルド番号
begin Number - ビルド開始日時(ミリ秒)
  • Unix Timestamp形式
end Number - ビルド終了日時(ミリ秒)
  • Unix Timestamp形式
userId String - ビルドリクエスタ ID
status String - ビルドの状態
  • prepare | upload | success | fail | canceled
    • prepare: ビルドプロビジョニング・実行中
    • upload: ビルド結果保存中
    • success: ビルド実行完了(最終結果を保存)
    • fail: ビルド実行失敗
    • canceled: ビルド実行をキャンセル
  • 最初のジョブ実行がない場合、nullと表示
failedPhase String - ビルド失敗段階
  • prepare | build | pre-build | post-build | upload | canceling | timeout
    • prepare: プロビジョニング段階で失敗
    • build: ビルド段階で失敗
    • pre-build: ビルド前コマンド段階で失敗
    • post-build: ビルド後コマンド段階で失敗
    • upload: ビルド結果アップロード段階で失敗
    • canceling: キャンセル中の状態
    • timeout: タイムアウトにより失敗
  • statussuccessの場合、nullと表示

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

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

レスポンス例

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

{
    "result": {
        "total": 2,
        "history": [
            {
                "projectId": 20***,
                "buildId": "92caa8f0-****-****-****-4f02d21ce8cd",
                "begin": 1747378022000,
                "end": 1747378032000,
                "userId": "nb******",
                "status": "canceled",
                "failedPhase": "prepare"
            },
            {
                "projectId": 20***,
                "buildId": "3f9d2490-****-****-****-4db7e2de2984",
                "begin": 1747363319000,
                "end": 1747363321000,
                "userId": "nb******",
                "status": "success",
                "failedPhase": null
            }
        ]
    }
}