SourceDeploy 개요

Prev Next

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

SourceDeploy는 새로 작성되거나 업데이트된 소스들을 자동으로 서버에 배포하고 적용해 주는 배포 자동화를 위한 네이버 클라우드 플랫폼의 서비스입니다. SourceDeploy 서비스에서는 배포 프로젝트별 스테이지 및 시나리오 구성, 시나리오 배포 및 분석 기능에 대한 API를 RESTful 형태로 제공합니다.

SourceDeploy 공통 설정

SourceDeploy API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

Classic: https://sourcedeploy.apigw.gov-ntruss.com/api/v1
VPC: https://vpcsourcedeploy.apigw.gov-ntruss.com/api/v1

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
x-ncp-apigw-timestamp Required 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
  • API Gateway 서버와 5분 이상 시간차 발생 시 유효하지 않은 요청으로 간주
x-ncp-iam-access-key Required 네이버 클라우드 플랫폼에서 발급받은 Access Key
x-ncp-apigw-signature-v2 Required 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명
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는 네이버 클라우드 플랫폼의 공통 응답 상태 코드를 사용합니다. 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.

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

SourceDeploy API

SourceDeploy 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

API 설명
프로젝트 생성 배포 프로젝트 생성
프로젝트 목록 조회 배포 프로젝트 목록 조회
프로젝트 삭제 배포 프로젝트 삭제
스테이지 생성 프로젝트 내 배포 스테이지 생성
스테이지 목록 조회 배포 스테이지 목록 조회
스테이지 조회 배포 스테이지 상세 정보 조회
스테이지 수정 배포 스테이지 설정 변경
스테이지 삭제 배포 스테이지 삭제
시나리오 생성 스테이지 내 배포 시나리오 생성
시나리오 목록 조회 배포 시나리오 목록 조회
시나리오 조회 배포 시나리오 상세 정보 조회
시나리오 배포 거절 시나리오 배포 거절
시나리오 배포 승인 시나리오 배포 승인
시나리오 배포 승인 요청 시나리오 배포의 승인 요청
시나리오 배포 시작 시나리오 배포 시작
시나리오 배포 이력 목록 조회 시나리오 배포 이력 조회
시나리오 배포 이력 조회 시나리오 배포 이력의 상세 정보 조회
시나리오 배포 취소 진행 중인 시나리오 배포 취소
시나리오 수정 배포 시나리오 설정 변경
시나리오 삭제 배포 시나리오 삭제
Canary 배포 승인 수동 분석한 Canary 버전 배포 인승인
Canary 배포 거절 수동 분석한 Canary 버전 배포 거절
Canary 분석 단계 목록 조회 Canary 분석 단계 목록 조회
Canary 분석 리포트 조회 Canary 분석 리포트 조회
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 그룹과 연결된 로드 밸런서 Trget Group 목록 조회

SourceDeploy 연관 리소스

SourceDeploy API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.