MENU
      프로젝트 상세 조회

        프로젝트 상세 조회


        기사 요약

        개요

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

        요청

        API URL

        TEnvPlatformConfig

        GET  {SOURCEBUILD_API_URL}/project/{projectId}
        Plain text

        요청 Parameter

        항목타입설명비고
        projectIdstring프로젝트 IDprojectList 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"
            }
        }
        JSON
        항목타입설명비고
        idnumber프로젝트 ID
        namestring프로젝트 이름
        descriptionstring프로젝트 설명
        source.type"SourceCommit" , "Github", "Bitbucket", "Github Enterprise Server"소스 저장소 타입
        source.configTSourceSourceCommitGithub | 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.idnumber빌드 환경의 컴퓨팅 유형 idbuildEnvComputeList API 로 조회
        env.compute.cpunumber빌드 환경의 vCPU 개수
        env.compute.memnumber빌드 환경의 mem 용량단위 : GB
        env.platform.type"SourceBuild" |"ContainerRegistry" |"PublicRegistry"빌드 환경의 이미지 저장소 타입SourceBuild: SourceBuild에서 관리되는 이미지,
        ContainerRegistry: Container Registry의 이미지
        PublicRegistry: Public Registry의 이미지
        env.platform.configTEnvSourceBuild | TEnvContainerRegistry | TEnvPublicRegistry빌드 환경 설정env.platform.type="SourceBuild" 일 경우, TEnvSourceBuild
        env.platform.type="ContainerRegistry" 일 경우, TEnvContainerRegistry
        env.platform.type="PublicRegistry" 일 경우, TEnvPublicRegistry
        아래 TEnvPlatformConfig 참조
        env.docker.useboolean도커 빌드를 위한 빌드 환경에 도커 엔진 포함(사용) 여부
        env.docker.idnumber도커 엔진 버전 idbuildEnvDockerList API 로 조회
        env.docker.namestring도커 엔진 이름
        env.timeoutnumber빌드 실행 타임 아웃단위 : 분
        env.envVars{"key": string, "value": string}[]빌드 환경 변수
        cmd.prestring[]빌드 전 명령어
        cmd.buildstring[]빌드 명령어
        cmd.poststring[]빌드 후 명령어
        cmd.dockerbuild.useboolean도커 이미지 빌드 설정 사용 여부
        cmd.dockerbuild.dockerfilestringdockerfile의 파일명을 포함한 경로source.config.repository 에 지정된 소스 저장소에 dockerfile 이 포함되어 있어야 하며, 경로는 소스 저장소의 최상위 위치로 부터의 경로를 입력.
        cmd.dockerbuild.registrystring이미지를 저장할 Container Registry 의 레지스트리 이름
        cmd.dockerbuild.imagestring이미지 이름
        cmd.dockerbuild.tagstring태그 이름
        cmd.dockerbuild.latestbooleanlatest 태그 저장 여부
        artifact.useboolean빌드 결과물 저장 여부
        artifact.pathstring[]빌드 결과물 위치source.config.repository 에 지정된 소스 저장소의 최상위 위치로 부터의 경로를 입력.파일 경로, 디렉토리 경로 모두 가능.
        artifact.storage.bucketstring결과물을 저장할 Object Storage 의 버킷 이름
        artifact.storage.pathstring결과물을 저장할 Object Storage 버킷 내 경로
        artifact.storage.filename결과물을 저장할 파일 이름zip 으로 압축되어 저장되며, 확장자가 zip 이 아닐경우 자동으로 .zip 이 포함되어 저장됩니다.
        artifact.backupboolean결과물 백업 여부
        cache.useboolean빌드 완료 후 빌드 환경 저장 여부빌드 완료 후 빌드 환경을 이미지화하여 저장할 수 있습니다.해당 이미지는 빌드 환경의 이미지로 설정하여 xxx 빌드로 사용하실 수 있습니다.
        cache.registrystring빌드 완료 후 빌드 환경의 이미지를 저장할 Container Registry 의 레지스트리 이름
        cache.imagestring이미지 이름
        cache.tagstring태그 이름
        cache.latestbooleanlatest 태그 저장 여부
        linked.CloudLogAnalyticsboolean빌드 로그를 Cloud Log Analytics 에 저장 여부
        linked.FileSaferboolean빌드 결과물을 File Safer (File Filter) 를 통한 검사 여부
        lastBuild.idstring마지막으로 빌드한 빌드 ID
        lastBuild.timestampnumber마지막 빌드 시각
        lastBuild.statusstring마지막으로 빌드한 빌드 상태

        TSourceConfig

        TSourceSourceCommitGithub

        {
            "repository": "string",
            "branch": "string"
        }
        Plain text
        항목타입설명비고
        repositorystring리포지토리
        branchstring브랜치

        TSourceBitbucket

        {
            "repository": "string",
            "branch": "string",
            "workspace": {
                "id": "string",
                "name": "string"
            }
        }
        Plain text
        항목타입설명비고
        repositorystring리포지토리
        branchstring브랜치
        workspace.idstringworkspace id
        workspace.namestringworkspace 이름

        TSourceGithubEnterpriseHttps

        {
            "owner": "string",
            "repository": "string",
            "branch": "string",
            "serverUrl": "string"
        }
        Plain text
        항목타입설명비고
        ownerstring소유자
        repositorystring리포지토리
        branchstring브랜치
        serverUrlstring서버 URL

        TSourceGithubEnterpriseSsh

        {
            "owner": "string",
            "repository": "string",
            "branch": "string",
            "url": "string"
        }
        Plain text
        항목타입설명비고
        ownerstring소유자
        repositorystring리포지토리
        branchstring브랜치
        urlstring리포지토리 URL

        TEnvPlatformConfig

        TEnvSourceBuild

        {
            "os": {
                "id": "number",
                "name": "string",
                "version": "string",
                "archi": "string"
            },
            "runtime": {
                "id": "number",
                "name": "string",
                "version": {
                    "id": "number",
                    "name": "string"
                }
            }
        }
        Plain text
        항목타입설명비고
        os.idnumber운영체제 IDbuildEnvOSList API 로 조회
        os.namestring운영체제 이름buildEnvOSList API 로 조회
        os.versionstring운영체제 버전buildEnvOSList API 로 조회
        os.archistring운영체제 아키텍처buildEnvOSList API 로 조회
        runtime.idnumber런타임 IDbuildEnvRunTimeList API 로 조회
        runtime.namestring런타임 이름buildEnvRunTimeList API 로 조회
        runtime.version.idnumber런타임 버전 IDbuildEnvRunTimeVersionList API 로 조회
        runtime.version.namestring런타임 버전 이름buildEnvRunTimeVersionList API 로 조회

        TEnvContainerRegistry

        {
        		"registry": "string",
        		"image": "string",
        		"tag": "string"
        }
        Plain text
        항목타입설명비고
        registrystring레지스트리 이름
        imagestring이미지 이름
        tagstring태그 이름

        TEnvPublicRegistry

        {
            "image": "string",
            "tag": "string"
        }
        Plain text
        항목타입설명비고
        imagestring이미지 이름
        tagstring태그 이름

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

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.