스테이지 수정

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

배포 스테이지의 설정을 변경합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
PATCH /api/v1/project/{projectId}/stage/{stageId}

요청 헤더

SourceDeploy API에서 공통으로 사용하는 헤더에 대한 정보는 SourceDeploy 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
projectId String Required 프로젝트 아이디
stageId String Required 배포 스테이지 아이디

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
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.gov-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 - 배포 스테이지 아이디
result.name String - 배포 스테이지 이름

응답 상태 코드

SourceDeploy API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 SourceDeploy 응답 상태 코드를 참조해 주십시오.

응답 예시

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