ステージの作成

Prev Next

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

デプロイステージを作成します。

リクエスト

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

メソッド URI
POST /api/v1/project/{projectId}/stage

リクエストヘッダ

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

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

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

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
name String Required デプロイステージ名
  • 英数字、記号の「-」、「_」を組み合わせて100文字以内で入力
type String Required デプロイターゲットタイプ
  • Server | AutoScalingGroup | KubernetesService | ObjectStorage
config Object Required デプロイターゲットの設定

TEnvServer

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

フィールド タイプ 必須の有無 説明
serverNo Array Required 対象のサーバ番号リスト

TEnvAutoScalingGroup

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

フィールド タイプ 必須の有無 説明
autoScalingGroupNo Number Required 対象の Auto Scalingグループ番号

TEnvKubernetesService

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

フィールド タイプ 必須の有無 説明
clusterNo Number Required 対象のクラスタ番号

TEnvObjectStorage

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

フィールド タイプ 必須の有無 説明
bucketName String Required 対象のバケット名

リクエスト例

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

curl --location --request POST 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/stage' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "dev1",
    "type": "Server",
    "config": {
        "serverNo": [1011*****, 1011*****]
    }
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
result Object - レスポンス結果
result.id Number - デプロイステージ ID
result.name String - デプロイステージ名

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

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

レスポンス例

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

{
    "result": {
        "id": 3***,
        "name": "dev1"
    }
}