SourceDeployの概要

Prev Next

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

SourceDeployは、新しく作成されたかアップデートされたソースを、自動でサーバにデプロイして適用するデプロイ自動化のための NAVERクラウドプラットフォームのサービスです。SourceDeployサービスは、デプロイプロジェクトごとのステージとシナリオの構成、シナリオのデプロイと分析機能関連の APIを RESTful形式で提供します。

SourceDeployの共通設定

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

リクエスト

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

API URL

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

Classic: https://sourcedeploy.apigw.ntruss.com
VPC: https://vpcsourcedeploy.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 (デフォルト)
Content-type Optional リクエストデータの形式
  • application/json
Accept Optional レスポンスデータの形式
  • application/json

レスポンス

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

レスポンスボディ

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

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

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

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

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

レスポンス例

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

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

SourceDeploy API

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

API 説明
プロジェクトの作成 デプロイプロジェクトを作成
プロジェクトリストの照会 デプロイプロジェクトリストを照会
プロジェクトの削除 デプロイプロジェクトを削除
ステージの作成 プロジェクト内にデプロイステージを作成
ステージリストの照会 デプロイステージリストを照会
ステージの照会 デプロイステージの詳細情報を照会
ステージの更新 デプロイステージの設定を変更
ステージの削除 デプロイステージを削除
シナリオの作成 ステージ内デプロイシナリオを作成
シナリオリストの照会 デプロイシナリオリストを照会
シナリオの照会 デプロイシナリオの詳細情報を照会
デプロイシナリオの拒否 デプロイシナリオを拒否
シナリオデプロイの承認 シナリオデプロイを承認
シナリオデプロイ承認のリクエスト シナリオデプロイの承認をリクエスト
シナリオデプロイの開始 シナリオデプロイを開始
シナリオデプロイ履歴リストの照会 シナリオデプロイ履歴を照会
シナリオデプロイ履歴の照会 シナリオデプロイ履歴の詳細情報を照会
シナリオデプロイのキャンセル 進行中のシナリオデプロイをキャンセル
シナリオの更新 デプロイシナリオの設定を変更
シナリオの削除 デプロイシナリオを削除
カナリアデプロイの承認 手動分析したカナリアバージョンデプロイを承認
カナリアデプロイの拒否 手動分析したカナリアバージョンデプロイを拒否
カナリア分析段階リストの照会 カナリア分析段階リストを照会
カナリア分析レポートの照会 カナリア分析レポートを照会
Auto Scalingグループリストの照会 使用可能な Auto Scalingグループリストを照会
Kubernetesクラスタリストの照会 使用可能な Ncloud Kubernetes Serviceクラスタリストを照会
Object Storageバケットリストの照会 使用可能な Object Storageバケットリストを照会
Object Storageオブジェクトリストの照会 使用可能な Object Storageオブジェクトリストを照会
Serverリストの照会 使用可能な Serverリストを照会
SourceCommitリポジトリリストの照会 使用可能な SourceCommitリポジトリリストを照会
SourceCommitブランチリストの照会 使用可能な SourceCommitリポジトリのブランチリストを照会
SourceBuildプロジェクトリストの照会 使用可能な SourceBuildプロジェクトリストを照会
Target Groupリストの照会 Auto Scalingグループに接続されたロードバランサ Target Groupリストを照会

SourceDeploy関連リソース

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