SourcePipelineの概要

Prev Next

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

SourcePipelineは、SourceCommit、SourceBuild、SourceDeployサービスを統合し、リポジトリ、ビルド、デプロイへと続くソフトウェアリリースプロセスを自動化する NAVERクラウドプラットフォームのサービスです。SourcePipelineサービスは、パイプラインの作成・実行機能関連の APIを RESTful形式で提供します。

SourcePipelineの共通設定

SourcePipeline APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

Classic: https://sourcepipeline.apigw.ntruss.com
VPC: https://vpcsourcepipeline.apigw.ntruss.com
参考

Classic環境は韓国リージョンのみサポートします。

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名
x-ncp-region_code Optional サービスを使用するリージョンコード
  • KR (デフォルト)
Accept Optional レスポンスデータの形式
  • application/json
Content-type Optional リクエストデータの形式
  • application/json

レスポンス

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

レスポンスボディ

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

error
errorは API呼び出し失敗情報を定義します。errorの説明は次の通りです。

フィールド タイプ 必須の有無 説明
error Object - エラーコードとメッセージ
error.errorCode String Required エラーコード
error.message String Required エラーメッセージ
error.details String Required エラーメッセージの詳細説明

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

SourcePipeline APIは NAVERクラウドプラットフォームの共通レスポンスステータスコードを使用します。NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
    "error": {
        "errorCode": "200",
        "message": "Authentication Failed",
        "details": "Invalid authentication information."
    }
}

SourcePipeline API

SourcePipelineサービスで提供する APIの説明は次の通りです。

API 説明
パイプラインの作成 パイプラインの作成
パイプラインリストの照会 パイプラインリストを照会
パイプラインの照会 パイプラインの詳細情報を照会
パイプライン実行履歴リストの照会 パイプライン実行履歴を照会
パイプライン実行履歴の照会 パイプライン実行履歴の詳細情報を照会
パイプライン予約トリガータイムゾーンの照会 パイプラインの予約トリガー設定時に適用可能なタイムゾーンリストを照会
パイプラインの更新 パイプラインの設定を変更
パイプラインの実行 パイプラインを実行
パイプライン実行のキャンセル 実行中パイプラインの実行をキャンセル
パイプラインの削除 パイプラインを削除
SourceCommitリポジトリリストの照会 使用可能な SourceCommitリポジトリリストを照会
SourceCommitブランチリストの照会 使用可能な SourceCommitリポジトリのブランチリストを照会
SourceBuildプロジェクトリストの照会 使用可能な SourceBuildプロジェクトリストを照会
SourceDeployステージリストの照会 使用可能な SourceDeployプロジェクトのデプロイステージリストを照会
SourceDeployシナリオリストの照会 使用可能な SourceDeployプロジェクトのデプロイシナリオリストを照会
SourceDeployプロジェクトリストの照会 使用可能な SourceDeployプロジェクトリストを照会

SourcePipeline関連リソース

SourcePipeline APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。