스테이지 목록 조회

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

배포 프로젝트 내 배포 스테이지 목록을 조회합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`projectId`	String	Required	프로젝트 아이디 프로젝트 목록 조회 참조

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`stageName`	String	Optional	검색 키워드 스테이지 이름이 전체 또는 부분 일치하는 값 필터링
`pageNo`	Number	Optional	페이지 번호 1~N (기본값: 1)
`pageSize`	Number	Optional	페이지당 항목 수 1~100 (기본값: 100)

요청 예시

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

curl --location --request GET 'https://vpcsourcedeploy.apigw.gov-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}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`result`	Object	-	응답 결과
`result.project`	Object	-	프로젝트 정보
`result.project.id`	Number	-	프로젝트 아이디
`result.project.name`	String	-	프로젝트 이름
`result.stageList`	Array	-	스테이지 목록

`stageList`

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

필드	타입	필수 여부	설명
`id`	Number	-	배포 스테이지 아이디
`name`	String	-	배포 스테이지 이름

응답 상태 코드

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

응답 예시

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

{
    "result": {
        "project": {
            "id": 2***,
            "name": "deploy3"
        },
        "stageList": [
            {
                "id": 3***,
                "name": "dev-sv"
            },
            {
                "id": 3***,
                "name": "dev-ob"
            },
            {
                "id": 3***,
                "name": "dev-nks"
            },
            {
                "id": 3***,
                "name": "dev-asg"
            }
        ]
    }
}