스테이지 조회

Prev Next

배포 스테이지의 상세 정보를 조회합니다.

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

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

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

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

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

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

curl --location --request GET 'https://sourcedeploy.apigw.fin-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}'
Shell

응답 형식을 설명합니다.

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

필드 타입 필수 여부 설명
result Object - 응답 결과
result.project Object - 프로젝트 정보
result.project.id Number - 프로젝트 아이디
result.project.name String - 프로젝트 이름
result.id Number - 배포 스테이지 아이디
result.name String - 배포 스테이지 이름
result.type String - 배포 타깃 타입
  • Server | AutoScalingGroup | KubernetesService | ObjectStorage
result.config Object - 배포 타깃 설정

TEnvServer

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

필드 타입 필수 여부 설명
serverNo Array Required 대상 서버 번호 목록

TEnvAutoScalingGroup

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

필드 타입 필수 여부 설명
autoScalingGroupNo Number Required 대상 Auto Scaling 그룹 번호

TEnvKubernetesService

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

필드 타입 필수 여부 설명
clusterNo Number Required 대상 클러스터 번호

TEnvObjectStorage

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

필드 타입 필수 여부 설명
bucketName String Required 대상 버킷 이름

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

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

{
    "result": {
        "project": {
            "id": 2***,
            "name": "deploy3"
        },
        "id": 3***,
        "name": "dev-sv",
        "type": "Server",
        "config": {
            "serverNo": [
                1011*****
            ],
            "serverName": [
                "svs"
            ]
        }
    }
}
JSON