배포 이력 상세

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

개요

SourceDeploy 이력 상세를 조회합니다.

요청

API URL

GET 	{SOURCEDEPLOY_API_URL}/project/{projectId}/history/{historyId}

요청 Parameter

항목	타입	설명	비고
projectId	string	프로젝트 ID	projectList 조회
historyId	string	히스토리 ID	historyList 조회

요청 Query

없음

요청 Body

없음

응답

응답 Body

{
    "project":{
        "id":"number",
        "name": "string"
    },
    "stage": {
        "id": "number",
        "name": "string"
    },
    "scenario": {
        "id": "number",
        "name": "string"
    },
    "id": "number",
    "status": "string",
    "executor": "string",
    "startTime": "number",
    "endTime": "number",
    "type": "string",
    "config": "THistoryServer" |"THistoryAutoScaling" | "THisotryKubernetesService" | "THistoryObjectStorage"
}

항목	타입	설명	비고
project.id	number	project id
project.name	string	project 이름
stage.id	number	stage id
stage.name	string	stage 이름
scenario.id	number	시나리오 id
scenario.name	string	시나리오 이름
id	number	history id
status	string	배포 상태	success (성공) fail(실패) inprogress(배포 중) pending(승인 대기 중) reject(승인 거절) canceling(배포 취소 중) canceled(배포 취소) waiting(배포 대기 중) error(Error) canary_pending(canary 배포 대기) canary_reject(canary 배포 취소) canary_analyzing(canary분석 중) canary_waiting_timeout(canary분석 시간 초과) canary_rejecting(canary배포 취소 중)
executor	string	배포 실행자
startTime	number	배포 시작 시각
endTime	number	배포 종료 시각
type	String	stage 타입	"Server" \| "AutoScalingGroup" \| "Kuberneteservice" \|"ObjectStroage"
config	THistoryServer \| THistoryAutoScaling \|THisotryKubernetesService \| THistoryObjectStorage	배포 설정 정보	type="Server" 일때, THistoryServer type="AutoScalingGroup"일때 , THistoryAutoScaling type="Kuberneteservice" 일때, THisotryKubernetesService type="ObjectStorage" 일때, THistoryObjectStorage

THistoryServer

[{
    "strategy": "string",
    "file": {
        "selected": "string",
        "type": "string"
    },
    "targets": [
        {
            "server": {
                "no": "number",
                "name": "string"
            },
            "status": "pending/standby/pre/deploy/post/success/fail/no progress",
            "time": {
                "pre": "timestamp",
                "deploy": "timestamp",
                "post": "timestamp"
            },
            "step": {
                "pre": "success/fail/inprogress",
                "deploy": "success/fail/inprogress",
                "post": "succss/fail/inprogress"
            }
        }
    ]
}]

항목	타입	설명	비고
strategy	string	배포 전략	"normal"
file.selected	string	배포 파일
file.type	string	배포 파일 타입
targets.server.no	number	Server No
targets.server.name	string	Server 이름
targets.status	string	배포 상태	pending(에이전트 응답 대기 중) standby(에이전트 연결 완료) pre\|deploy\|post(각단계 배포 진행 중) success(배포 성공) fail(배포 실패) no progress(배포 진행 안 함)
targets.time.pre	number	배포 전 시각
targets.time.deploy	number	파일 배포 시각
targets.time.post	number	배포 후 시각
targets.step.pre	string	배포 전 상태	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	파일 배포 상태	"success" \| "fail" \| "inprogress"
targets.step.post	string	배포 후 상태	"success" \| "fail" \| "inprogress"

THistoryAutoScaling

{
        "strategy": "normal/blueGreen",
        "autoScalingGroup": {
            "no": "number",
            "name": "string"
        },
        "file": {
            "selected": "string",
            "type": "string"
        },
        "targets": [
            {
                "server": {
                    "no": "number",
                    "name": "string"
                },
                "status": "pending/standby/pre/deploy/post/success/fail/no progress",
                "time": {
                    "pre": "timestamp",
                    "deploy": "timestamp",
                    "post": "timestamp"
                },
                "step": {
                    "pre": "success/fail/inprogress",
                    "deploy": "success/fail/inprogress",
                    "post": "succss/fail/inprogress"
                }
            }
        ]
}

항목	타입	설명	비고
strategy	string	배포 전략	"normal" \| "blueGreen"
autoScalingGroup.no	number	AutoScalingGroup No
autoScalingGroup.name	string	AutoScalingGroup 이름
file.selected	string	배포 파일
file.type	string	배포 파일 타입
targets.server.no	number	Server No
targets.server.name	string	Server 이름
targets.status	string	배포 상태	pending(에이전트 응답 대기 중) standby(에이전트 연결 완료) pre\|deploy\|post(각단계 배포 진행 중) success(배포 성공) fail(배포 실패) no progress(배포 진행 안 함)
targets.time.pre	number	배포 전 시각
targets.time.deploy	number	파일 배포 시각
targets.time.post	number	배포 후 시각
targets.step.pre	string	배포 전 상태	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	파일 배포 상태	"success" \| "fail" \| "inprogress"
targets.step.post	string	배포 후 상태	"success" \| "fail" \| "inprogress"

THisotryKubernetesService

{
        "strategy": "normal/blueGreen/rolling/canary",
        "targets": {
            "time": {
                "pre": "timestamp",
                "deploy": "timestamp"
            },
            "step": {
                "pre": "success/fail/inprogress",
                "deploy": "success/fail/inprogress"
            }
        }
}

항목	타입	설명	비고
strategy	string	배포 전략	"normal" \| "blueGreen" \| "rolling" \| "canary"
targets.time.pre	number	배포 준비 시각
targets.time.deploy	number	배포 시각
targets.step.pre	string	배포 준비 상태	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	배포 상태	"success" \| "fail" \| "inprogress"

THistoryObjectStorage

{
        "file": {
            "selected": "string",
            "type": "string"
        },
        "targets": {
            "time": {
                "pre": "timestamp",
                "deploy": "timestamp"
            },
            "step": {
                "pre": "success/fail/inprogress",
                "deploy": "success/fail/inprogress"
            }
        },
        "backupFile": "string"
}

항목	타입	설명	비고
file.selected	string	배포 파일
file.type	string	배포 파일 타입
targets.time.pre	number	배포 준비 시각
targets.time.deploy	number	배포 시각
targets.step.pre	string	배포 준비 상태	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	배포 상태	"success" \| "fail" \| "inprogress"
backupFile	string	백업 파일

이 문서가 도움이 되었습니까?

What's Next

Canary 분석 단계 목록 조회

개요
요청
응답

태그

SourceDeploy