SourceCommitの概要

Prev Next

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

SourceCommitは、ソースコードとさまざまなファイルを安全に保存するためのプライベート Gitリポジトリとして提供される NAVERクラウドプラットフォームのサービスです。SourceCommitサービスは、リポジトリの作成、管理を行う APIを RESTful形式で提供します。

SourceCommitの共通設定

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

リクエスト

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

API URL

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

https://sourcecommit.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 エラーメッセージの詳細説明

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

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

レスポンス例

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

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

SourceCommit API

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

API 説明
リポジトリの作成 リポジトリを作成
リポジトリリストを照会 リポジトリリストを照会
リポジトリを照会 のリポジトリ詳細情報を照会
リポジトリの照会(by ID) リポジトリ IDを利用してレポジトリの詳細情報を照会
ブランチリストの照会 ブランチリストを照会
タグリストの照会 タグリストを照会
デフォルトブランチの設定 デフォルトブランチの設定
リポジトリの更新 リポジトリの設定変更
リポジトリの更新(by ID) リポジトリ IDを利用してレポジトリの設定を変更
リポジトリの削除 リポジトリを削除
リポジトリの削除(by ID) リポジトリ IDを利用してレポジトリを削除

SourceCommit関連リソース

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