Peer 목록 조회

Prev Next

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

블록체인 네트워크를 유지하고 원장과 체인코드를 관리하는 Peer의 목록을 조회합니다.

요청

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

메서드 URI
GET /networks/{networkId}/peers

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
networkId Long Required 네트워크 아이디

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
page Integer Optional 페이지 번호
  • 0 (기본값)
size Integer Optional 조회 결과 목록 크기
  • 20 (기본값)

요청 예시

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

curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks/{networkId}/peers' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
content Array - Content 상세 정보
totalElements Long - 전체 Peer 노드 수
totalPages Integer - 전체 페이지 수

content

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

필드 타입 필수 여부 설명
networkId Long - 네트워크 아이디
peerId String - Peer 아이디
peerName String - Peer 이름
statusDatabaseType String - Peer의 State 데이터베이스 타입
  • LEVEL_DB | COUCH_DB
    • LEVEL_DB: 빠른 성능과 간단한 데이터 구조를 지원하는 경량 DB
    • COUCH_DB: JSON 데이터와 복잡한 쿼리 및 검색 기능을 제공하는 문서 기반 DB
mspId String - Peer MSP 아이디
status String - Peer 상태
  • ACTIVE | DEPLOY | DELETE
    • ACTIVE: 운영 중
    • DEPLOY: 배포 중
    • DELETE: 삭제 중
createDate LocalDateTime - Peer 생성 일시(YYYY-MM-DDTHH:MM:SS+0000)
updateDate LocalDateTime - Peer 수정 일시(YYYY-MM-DDTHH:MM:SS+0000)

응답 상태 코드

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

응답 예시

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

{
    "content": [
        {
            "networkId": 1630,
            "peerId": "25738634",
            "peerName": "test-peer2",
            "statusDatabaseType": "LEVEL_DB",
            "mspId": "test-msp",
            "status": "ACTIVE",
            "createDate": "2024-07-30T00:29:32+0000",
            "updateDate": "2024-08-08T16:29:32+0000"
        }
    ],
    "totalElements": 1,
    "totalPages": 1
}