SourceDeploy 시나리오 목록 조회

Prev Next

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

사용 가능한 SourceDeploy 프로젝트의 배포 시나리오 목록을 조회합니다.

요청

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

메서드 URI
GET /api/v1/sourcedeploy/project/{projectId}/stage/{stageId}/scenario

요청 헤더

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

요청 경로 파라미터

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

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
pageNo Number Optional 페이지 번호
  • 1~N
  • pageSize 입력 시 필수 입력
pageSize Number Optional 페이지당 항목 수
  • 1~N
  • pageNo 입력 시 필수 입력
searchWord String Optional 검색 키워드
  • 시나리오 이름이 전체 또는 부분 일치하는 값 필터링

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://vpcsourcepipeline.apigw.gov-ntruss.com/api/v1/sourcedeploy/project/2***/stage/3***/scenario?pageNo=1&pageSize=10&searchWord=te' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
result Object - 응답 결과
result.scenarioList Array - 배포 시나리오 목록

scenarioList

scenarioList에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
id Number - 배포 시나리오 아이디
name String - 배포 시나리오 이름
source Object - 배포 대상 정보
source.type String - 배포 파일 유형
  • SourceBuild | ObjectStorage | KubernetesService
source.target Object - 배포 파일 정보
source.target.projectName String - 빌드 프로젝트 이름
  • type이 SourceBuild인 경우, 표시
source.target.file String - Object Storage 내 파일 위치
  • type이 ObjectStorage인 경우, 표시
source.target.manifest String - 매니페스트 파일 위치
  • type이 KubernetesService인 경우, 표시

응답 상태 코드

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

응답 예시

응답 예시는 다음과 같습니다.

{
    "result": {
        "scenarioList": [
            {
                "id": 2***,
                "name": "testscenario2",
                "source": {
                    "type": "ObjectStorage",
                    "target": {
                        "file": "data2/sample_build_output.zip"
                    }
                }
            },
            {
                "id": 2***,
                "name": "testscenario",
                "source": {
                    "type": "SourceBuild",
                    "target": {
                        "projectName": "build1"
                    }
                }
            }
        ]
    }
}