프로젝트 목록 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

배포 프로젝트 목록을 조회합니다.

요청

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

메서드 URI
GET /api/v1/project

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
projectName String Optional 검색 키워드
  • 프로젝트 이름이 전체 또는 부분 일치하는 값 필터링
pageNo Number Optional 페이지 번호
  • 1~N (기본값: 1)
pageSize Number Optional 페이지당 항목 수
  • 1~N
    • 미입력 시 전체 목록 표시

요청 예시

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

curl --location --request GET 'https://sourcebuild.apigw.gov-ntruss.com/api/v1/project?projectName=Build3&pageNo=1&pageSize=100' \
--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.total Number - 응답 결과 수
result.project Array - 프로젝트 목록

project

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

필드 타입 필수 여부 설명
id Number - 프로젝트 아이디
name String - 프로젝트 이름
permission String - 상세 정보 조회 권한 소유 여부
  • Allow | Deny
    • Allow: 소유
    • Deny: 소유 안 함
actionName String - 상세 정보 조회 권한 이름

응답 상태 코드

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

응답 예시

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

{
    "result": {
        "total": 2,
        "project": [
            {
                "id": 20632,
                "name": "Build001",
                "permission": "Allow",
                "actionName": "View/getProjectDetail"
            },
            {
                "id": 20631,
                "name": "Build002",
                "permission": "Allow",
                "actionName": "View/getProjectDetail"
            }
        ]
    }
}