Classic/VPC 환경에서 이용 가능합니다.
배포 프로젝트의 상세 정보를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /api/v1/project/{projectId} |
요청 헤더
SourceBuild API에서 공통으로 사용하는 헤더에 대한 정보는 SourceBuild 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
projectId |
String | Required | 프로젝트 아이디
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://sourcebuild.apigw.gov-ntruss.com/api/v1/project/20***' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
result |
Object | - | 응답 결과 |
result.id |
Number | - | 프로젝트 아이디 |
result.name |
String | - | 프로젝트 이름 |
result.description |
String | - | 프로젝트 설명 |
result.created |
Object | - | 프로젝트 생성 정보 |
result.created.timestamp |
Number | - | 프로젝트 생성 일시
|
result.created.user |
String | - | 생성자 아이디 |
result.source |
Object | - | 소스 저장소 정보 |
result.source.type |
String | - | 소스 저장소 타입
|
result.source.config |
Object | - | 소스 저장소 리포지토리 정보 |
result.source.config.repository |
String | - | 소스 저장소 리포지토리 이름
|
result.source.config.branch |
String | - | 소스 저장소 리포지토리 브랜치 이름
|
result.source.config.workspace.id |
String | - | Bitbucket 워크스페이스 아이디
|
result.source.config.workspace.name |
String | - | Bitbucket 워크스페이스 이름
|
owner |
String | - | Github Enterprise Server 소유자
|
url |
String | - | Git 리포지토리 URL
|
serverUrl |
String | - | 서버 URL
|
result.env |
Object | - | 빌드 환경 정보 |
result.env.timeout |
Number | - | 빌드 실행 타임아웃(분) |
result.env.envVars |
Array | - | 빌드 환경 변수 정보 |
result.env.compute |
Object | - | 컴퓨팅 유형 정보 |
result.env.compute.id |
Number | - | 컴퓨팅 유형 아이디 |
result.env.compute.cpu |
Number | - | vCPU 수 |
result.env.compute.mem |
Number | - | 메모리 용량(GB) |
result.env.platform |
Object | - | 빌드 환경 플랫폼 정보 |
result.env.platform.type |
String | - | 이미지 저장소 타입
|
result.env.platform.config |
Object | - | 빌드 환경 설정 정보 |
result.env.platform.config.os |
Object | - | 운영 체제 정보
|
result.env.platform.config.os.id |
Number | - | 운영 체제 아이디 |
result.env.platform.config.os.name |
String | - | 운영 체제 이름 |
result.env.platform.config.os.version |
String | - | 운영 체제 버전 |
result.env.platform.config.os.archi |
String | - | 운영 체제 아키텍처 |
result.env.platform.config.runtime |
Object | - | 런타임 정보
|
result.env.platform.config.runtime.id |
Number | - | 런타임 유형 아이디 |
result.env.platform.config.runtime.name |
String | - | 런타임 이름 |
result.env.platform.config.runtime.version |
Object | - | 런타임 버전 정보 |
result.env.platform.config.runtime.version.id |
Number | - | 런타임 버전 아이디 |
result.env.platform.config.runtime.version.name |
String | - | 런타임 버전 이름 |
result.env.platform.config.registry |
Object | - | 레지스트리 정보
|
result.env.platform.config.image |
String | - | 이미지 이름
|
result.env.platform.config.tag |
String | - | 이미지 태그 이름
|
result.env.docker |
Object | - | 도커 엔진 정보 |
result.env.docker.use |
Boolean | - | 도커 엔진 포함 여부
|
result.env.docker.id |
Number | - | 도커 엔진 버전 아이디
|
result.env.docker.name |
String | - | 도커 엔진 이름
|
result.cmd |
Object | - | 빌드 명령어 정보 |
result.cmd.pre |
Array | - | 빌드 전 명령어 |
result.cmd.build |
Array | - | 빌드 명령어 |
result.cmd.post |
Array | - | 빌드 후 명령어 |
result.cmd.dockerbuild |
Object | - | 도커 이미지 빌드 정보
|
result.cmd.dockerbuild.use |
Boolean | - | 도커 이미지 빌드 설정 사용 여부
|
result.cmd.dockerbuild.dockerfile |
String | - | dockerfile 경로 |
result.cmd.dockerbuild.registry |
String | - | Container Registry 이름 |
result.cmd.dockerbuild.image |
String | - | 이미지 이름 |
result.cmd.dockerbuild.tag |
String | - | 이미지 태그 이름 |
result.cmd.dockerbuild.latest |
Boolean | - | latest 태그 설정 여부
|
result.artifact |
Object | - | 빌드 결과물 정보
|
result.artifact.use |
Boolean | - | 빌드 결과물 저장 여부
|
result.artifact.path |
String | - | 빌드 결과물 저장 경로 |
result.artifact.storage |
Object | - | 결과물 저장소 정보 |
result.artifact.storage.bucket |
String | - | 결과물을 저장할 Object Storage 버킷 이름 |
result.artifact.storage.path |
String | - | 결과물을 저장할 Object Storage 버킷 내 경로 |
result.artifact.storage.filename |
String | - | 결과물을 저장할 파일 이름 |
result.artifact.backup |
Boolean | - | 결과물 백업 여부
|
result.cache |
Object | - | 빌드 완료 후 이미지 저장 정보
|
result.cache.use |
Boolean | - | 빌드 완료 후 이미지 저장 여부
|
result.cache.registry |
String | - | Container Registry 이름 |
result.cache.image |
String | - | 이미지 이름 |
result.cache.tag |
String | - | 이미지 태그 이름 |
result.cache.latest |
Boolean | - | latest 태그 설정 여부
|
result.linked |
Object | - | 연동 서비스 정보 |
result.linked.FileSafer |
Boolean | - | File Safer 연동 여부
|
result.linked.CloudLogAnalytics |
Boolean | - | Cloud Log Analytics 연동 여부
|
result.lastBuild |
Object | - | 최근 빌드 작업 정보 |
result.lastBuild.id |
String | - | 빌드 번호
|
result.lastBuild.timestamp |
Number | - | 빌드 일시
|
result.lastBuild.status |
String | - | 빌드 상태
|
envVars
envVars
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
key |
String | - | 환경 변수 키 |
value |
String | - | 환경 변수 값 |
응답 상태 코드
SourceBuild API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 SourceBuild 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"result": {
"id": 20***,
"name": "Build001",
"description": "Build001",
"created": {
"timestamp": 1747294359000,
"user": "nb******"
},
"source": {
"type": "SourceCommit",
"config": {
"repository": "repository001",
"branch": "master"
}
},
"env": {
"timeout": 60,
"envVars": [
{
"key": "env1",
"value": "value1"
}
],
"compute": {
"id": 1,
"cpu": 2,
"mem": 4
},
"platform": {
"type": "SourceBuild",
"config": {
"os": {
"id": 1,
"name": "ubuntu",
"version": "16.04",
"archi": "x64"
},
"runtime": {
"id": 5,
"name": "python",
"version": {
"id": 27,
"name": "3.10-1.0.0"
}
}
}
},
"docker": {
"use": true,
"id": 1,
"name": "Docker:18.09.1"
}
},
"cmd": {
"pre": [],
"build": [],
"post": [],
"dockerbuild": {
"use": false
}
},
"artifact": {
"use": false
},
"cache": {
"use": false
},
"linked": {
"FileSafer": false,
"CloudLogAnalytics": false
},
"lastBuild": {
"id": "4e3c7860-****-****-****-4db7e2de2984",
"timestamp": 1747363743000,
"status": "success"
}
}
}