프로젝트 상세 조회

인쇄
공유
PDF

프로젝트 상세 조회

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

개요

SourceBuild 프로젝트를 상세 조회합니다.

요청

API URL

TEnvPlatformConfig

GET  {SOURCEBUILD_API_URL}/project/{projectId}

요청 Parameter

항목	타입	설명	비고
projectId	string	프로젝트 ID	projectList API 로 조회

요청 Query

없음

요청 Body

없음

응답

응답 Body

{
    "id": "number",
    "name": "string",
    "description": "string",
    "created": {
        "timestamp": "number",
        "user": "string"
    },
    "source": {
        "type": "string",
        "config": "TSourceSourceCommitGithub", | "TSourceBitbucket" |  "TSourceGithubEnterpriseHttps" | "TSourceGithubEnterpriseSsh"
    },
    "env": {
        "compute": {
            "id": "number",
            "cpu": "number",
            "mem": "number"
        },
        "platform": {
            "type": "string",
            "config": "TEnvSourceBuild" | "TEnvContainerRegistry" | "TEnvPublicRegistry"
        },
        "docker": {
            "use": "boolean",
            "id": "number",
            "name": "string"
        },
        "timeout": "number",
        "envVars": [
            {
                "key": "string",
                "value": "stirng"
            }
        ]
    },
    "cmd": {
        "pre": ["string"],
        "build": ["string"],
        "post": ["string"],
        "dockerbuild": {
            "use": "boolean",
            "dockerfile": "string",
            "registry": "string",
            "image": "string",
            "tag": "string",
            "latest": "boolean"
        }
    },
    "artifact": {
        "use": "boolean",
        "path": "string",
        "storage": {
            "bucket": "string",
            "path": "string",
            "filename": "string"
        },
        "backup": "boolean"
    },
    "cache": {
        "use": "boolean",
        "registry": "string",
        "image": "string",
        "tag": "string",
        "latest": "boolean"
    },
    "linked": {
        "CloudLogAnalytics": "boolean",
        "FileSafer": "boolean"
    },
    "lastBuild": {
        "id": "string",
        "timestamp": "number",
        "status": "string"
    }
}

항목	타입	설명	비고
id	number	프로젝트 ID
name	string	프로젝트 이름
description	string	프로젝트 설명
source.type	"SourceCommit" , "Github", "Bitbucket", "Github Enterprise Server"	소스 저장소 타입
source.config	TSourceSourceCommitGithub \| TSourceBitbucket \| TSourceGithubEnterpriseHttps \| TSourceGithubEnterpriseSsh	소스 저장소 리파지토리 이름	source.type="SourceCommit" 또는 "Github" 일 경우, TSourceSourceCommitGithub source.type="Bitbucket" 일 경우, TSourceBitbucket source.type="Github Enterprise Server" & OAuth, Personal Access Token, Username / Password 으로 로그인한 경우, TSourceGithubEnterpriseHttps source.type="Github Enterprise Server" & SSH key 로 로그인 한 경우 TSourceGithubEnterpriseSsh
env.compute.id	number	빌드 환경의 컴퓨팅 유형 id	buildEnvComputeList API 로 조회
env.compute.cpu	number	빌드 환경의 vCPU 개수
env.compute.mem	number	빌드 환경의 mem 용량	단위 : GB
env.platform.type	"SourceBuild" \|"ContainerRegistry" \|"PublicRegistry"	빌드 환경의 이미지 저장소 타입	SourceBuild: SourceBuild에서 관리되는 이미지, ContainerRegistry: Container Registry의 이미지 PublicRegistry: Public Registry의 이미지
env.platform.config	TEnvSourceBuild \| TEnvContainerRegistry \| TEnvPublicRegistry	빌드 환경 설정	env.platform.type="SourceBuild" 일 경우, TEnvSourceBuild env.platform.type="ContainerRegistry" 일 경우, TEnvContainerRegistry env.platform.type="PublicRegistry" 일 경우, TEnvPublicRegistry 아래 TEnvPlatformConfig 참조
env.docker.use	boolean	도커 빌드를 위한 빌드 환경에 도커 엔진 포함(사용) 여부
env.docker.id	number	도커 엔진 버전 id	buildEnvDockerList API 로 조회
env.docker.name	string	도커 엔진 이름
env.timeout	number	빌드 실행 타임 아웃	단위 : 분
env.envVars	{"key": string, "value": string}[]	빌드 환경 변수
cmd.pre	string[]	빌드 전 명령어
cmd.build	string[]	빌드 명령어
cmd.post	string[]	빌드 후 명령어
cmd.dockerbuild.use	boolean	도커 이미지 빌드 설정 사용 여부
cmd.dockerbuild.dockerfile	string	dockerfile의 파일명을 포함한 경로	source.config.repository 에 지정된 소스 저장소에 dockerfile 이 포함되어 있어야 하며, 경로는 소스 저장소의 최상위 위치로 부터의 경로를 입력.
cmd.dockerbuild.registry	string	이미지를 저장할 Container Registry 의 레지스트리 이름
cmd.dockerbuild.image	string	이미지 이름
cmd.dockerbuild.tag	string	태그 이름
cmd.dockerbuild.latest	boolean	latest 태그 저장 여부
artifact.use	boolean	빌드 결과물 저장 여부
artifact.path	string[]	빌드 결과물 위치	source.config.repository 에 지정된 소스 저장소의 최상위 위치로 부터의 경로를 입력.파일 경로, 디렉토리 경로 모두 가능.
artifact.storage.bucket	string	결과물을 저장할 Object Storage 의 버킷 이름
artifact.storage.path	string	결과물을 저장할 Object Storage 버킷 내 경로
artifact.storage.filename		결과물을 저장할 파일 이름	zip 으로 압축되어 저장되며, 확장자가 zip 이 아닐경우 자동으로 .zip 이 포함되어 저장됩니다.
artifact.backup	boolean	결과물 백업 여부
cache.use	boolean	빌드 완료 후 빌드 환경 저장 여부	빌드 완료 후 빌드 환경을 이미지화하여 저장할 수 있습니다.해당 이미지는 빌드 환경의 이미지로 설정하여 xxx 빌드로 사용하실 수 있습니다.
cache.registry	string	빌드 완료 후 빌드 환경의 이미지를 저장할 Container Registry 의 레지스트리 이름
cache.image	string	이미지 이름
cache.tag	string	태그 이름
cache.latest	boolean	latest 태그 저장 여부
linked.CloudLogAnalytics	boolean	빌드 로그를 Cloud Log Analytics 에 저장 여부
linked.FileSafer	boolean	빌드 결과물을 File Safer (File Filter) 를 통한 검사 여부
lastBuild.id	string	마지막으로 빌드한 빌드 ID
lastBuild.timestamp	number	마지막 빌드 시각
lastBuild.status	string	마지막으로 빌드한 빌드 상태

TSourceConfig

TSourceSourceCommitGithub

{
    "repository": "string",
    "branch": "string"
}

항목	타입	설명	비고
repository	string	리포지토리
branch	string	브랜치

TSourceBitbucket

{
    "repository": "string",
    "branch": "string",
    "workspace": {
        "id": "string",
        "name": "string"
    }
}

항목	타입	설명
repository	string	리포지토리
branch	string	브랜치
workspace.id	string	workspace id
workspace.name	string	workspace 이름

TSourceGithubEnterpriseHttps

{
    "owner": "string",
    "repository": "string",
    "branch": "string",
    "serverUrl": "string"
}

항목	타입	설명
owner	string	소유자
repository	string	리포지토리
branch	string	브랜치
serverUrl	string	서버 URL

TSourceGithubEnterpriseSsh

{
    "owner": "string",
    "repository": "string",
    "branch": "string",
    "url": "string"
}

항목	타입	설명
owner	string	소유자
repository	string	리포지토리
branch	string	브랜치
url	string	리포지토리 URL

TEnvPlatformConfig

TEnvSourceBuild

{
    "os": {
        "id": "number",
        "name": "string",
        "version": "string",
        "archi": "string"
    },
    "runtime": {
        "id": "number",
        "name": "string",
        "version": {
            "id": "number",
            "name": "string"
        }
    }
}

항목	타입	설명	비고
os.id	number	운영체제 ID	buildEnvOSList API 로 조회
os.name	string	운영체제 이름	buildEnvOSList API 로 조회
os.version	string	운영체제 버전	buildEnvOSList API 로 조회
os.archi	string	운영체제 아키텍처	buildEnvOSList API 로 조회
runtime.id	number	런타임 ID	buildEnvRunTimeList API 로 조회
runtime.name	string	런타임 이름	buildEnvRunTimeList API 로 조회
runtime.version.id	number	런타임 버전 ID	buildEnvRunTimeVersionList API 로 조회
runtime.version.name	string	런타임 버전 이름	buildEnvRunTimeVersionList API 로 조회

TEnvContainerRegistry

{
		"registry": "string",
		"image": "string",
		"tag": "string"
}

항목	타입	설명
registry	string	레지스트리 이름
image	string	이미지 이름
tag	string	태그 이름

TEnvPublicRegistry

{
    "image": "string",
    "tag": "string"
}

항목	타입	설명	비고
image	string	이미지 이름
tag	string	태그 이름

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

What's Next

프로젝트 생성

개요
요청
응답

태그

SourceBuild