ステージの更新

Prev Next

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

デプロイステージの設定を変更します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエストボディ

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

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

TEnvServer

デプロイターゲットがServerの場合、configの説明は次の通りです。

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

TEnvAutoScalingGroup

デプロイターゲットがAutoScalingGroupの場合、configの説明は次の通りです。

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

TEnvKubernetesService

デプロイターゲットがKubernetesServiceの場合、configの説明は次の通りです。

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

TEnvObjectStorage

デプロイターゲットがObjectStorageの場合、configの説明は次の通りです。

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

リクエスト例

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

curl --location --request PATCH 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/stage/3***' \
--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 '{
    "type": "ObjectStorage",
    "config": {
        "bucketName": "devtool"
    }
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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