SourceBuildの概要

Prev Next

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

SourceBuildは、さまざまな言語で開発されたソースコードを簡単にビルドする NAVERクラウドプラットフォームのサービスです。SourceBuildサービスは、プロジェクトの作成、設定、ビルドを行う APIを RESTful形式で提供します。

SourceBuildの共通設定

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

リクエスト

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

API URL

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

https://sourcebuild.apigw.ntruss.com

リクエストヘッダ

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

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • Unix Timestamp形式
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 (デフォルト)
Content-type Optional リクエストデータの形式
  • application/json

レスポンス

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

レスポンスボディ

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

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

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

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

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

レスポンス例

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

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

SourceBuild API

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

API 説明
プロジェクトの作成 SourceBuildプロジェクトの作成
プロジェクトリストの照会 SourceBuildのプロジェクトリストを照会
プロジェクトの照会 SourceBuildプロジェクトの詳細情報を照会
プロジェクトの更新 SourceBuildプロジェクトの設定を変更
プロジェクトの削除 プロジェクトの削除
ビルドの開始 ビルドの開始
ビルド履歴の照会 ビルド履歴の照会
ビルドのキャンセル ビルドのキャンセル
OSリストの照会 OSリストを照会
コンピューティングタイプリストの照会 コンピューティングタイプリストの照会
ランタイムタイプリストの照会 ランタイムタイプリストの照会
ランタイムバージョンリストの照会 ランタイムバージョンリストの照会
Dockerエンジンリストの照会 Dockerエンジンリストの照会
SourceCommitリポジトリリストの照会 SourceCommitのリポジトリリストを照会
SourceCommitブランチリストの照会 SourceCommitブランチの照会
Object Storageバケットリストの照会 Object Storageバケットリストを照会
Container Registryリストの照会 Container Registryリストの照会

SourceBuild関連リソース

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