Orderer 정보 조회

Prev Next

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

블록체인 네트워크의 Orderer 상세 정보를 조회합니다.

요청

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

메서드 URI
GET /networks/{networkId}/orderers/{ordererId}

요청 헤더

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

요청 경로 파라미터

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

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

요청 예시

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

curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks/{networkId}/orderers/{ordererId}' \
--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 Object - Orderer 상세 정보
content.networkId Long - 네트워크 아이디
content.ordererId String - Orderer 아이디
content.ordererName String - Orderer 이름
content.mspId String - Orderer MSP 아이디
content.ordererType String - Orderer 구성 타입
  • Raft 1 | Raft 5
    • Raft 1: 단일 노드(Single)
    • Raft 5: 다중 노드(Multiple)
content.endpointAddr Array<String> - Orderer URL 주소
content.adminIdentityName String - Admin Orderer CA 이름
content.exportNetworkId Long - 다른 네트워크에서 가져온 네트워크 아이디
  • importYn이 Y일 때 표시
content.exportOrdererId String - 다른 네트워크에서 가져온 Orderer 아이디
  • importYn이 Y일 때 표시
content.ordererResourceCpu Float - Orderer Pod에 할당된 CPU 용량 (단위: core)
content.ordererResourceMem Integer - Orderer Pod에 할당된 Memory 용량 (단위: MB)
content.ordererResourceStorage Integer - Orderer Pod에 할당된 Storage 용량 (단위: MiB)
content.batchConfigTimeout Integer - 트랜잭션을 모아서 블록을 생성하는 간격 (단위: 초)
  • 0 (기본값)
content.batchConfigMaxMessageCount Integer - 블록을 생성할 때 포함하는 최대 트랜잭션 수 (단위: 개)
  • 0 (기본값)
content.batchConfigPreferredMaxBytes Integer - 블록을 생성할 때 최대 크기 (단위: MB)
  • 0 (기본값)
content.batchConfigAbsoluteMaxBytes Integer - 블록을 생성할 때 기준이 되는 최대 크기 (단위: MB)
  • 0 (기본값)
content.nodeAffinityLabel String - Orderer 노드가 배치된 Ncloud Kubernetes Service 클러스터 노드풀의 라벨 이름
content.importYn Boolean - Orderer MSP 가져오기(Import) 여부
  • Y | N (기본값)
    • Y: 다른 네트워크에서 가져온 Orderer MSP
    • N: 현재 네트워크의 Orderer MSP
content.status String - Orderer 상태
  • ACTIVE | DEPLOY | DELETE
    • ACTIVE: 운영 중
    • DEPLOY: 배포 중
    • DELETE: 삭제 중
content.consortiumList Array - consortiumList 상세 정보
content.channelList Array - channelList 상세 정보
content.podStatus Array - podStatus 상세 정보
content.createDate LocalDateTime - Orderer 생성 일시(YYYY-MM-DDTHH:MM:SS+0000)

consortiumList

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

필드 타입 필수 여부 설명
networkId Long - 컨소시엄이 구성된 네트워크 아이디
networkName String - 컨소시엄이 구성된 네트워크 이름
mspId String - 컨소시엄이 구성된 MSP 아이디
mspName String - 컨소시엄이 구성된 MSP 이름
importYn Boolean - Orderer MSP 가져오기(Import) 여부
  • Y | N (기본값)
    • Y: 다른 네트워크에서 가져온 Orderer MSP
    • N: 현재 네트워크의 Orderer MSP

channelList

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

필드 타입 필수 여부 설명
networkId Long - 채널이 생성된 네트워크 아이디
ordererId String - 채널이 생성된 Orderer 아이디
channelName String - 채널 이름
operator String - 채널 Operator 이름

podStatus

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

필드 타입 필수 여부 설명
podStatus String - Orderer Pod의 라이프사이클(Lifecycle) 단계
  • Running | Pending | Failed | Unknown
    • Running: 실행 중
    • Pending: 대기 중
    • Failed: 작동 실패
    • Unknown: 상태 확인 불가
ordererResourceStorage Integer - Orderer Pod에 할당된 Storage 용량 (단위: MiB)
name String - Orderer Pod 이름
ordererResourceMem Integer - Orderer Pod에 할당된 Memory 용량 (단위: MB)
ordererResourceCpu Integer - Orderer Pod에 할당된 CPU 용량 (단위: core)

응답 상태 코드

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

응답 예시

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

단일 노드(Raft 1) 타입의 네트워크 아이디로 조회한 경우

단일 노드(Raft 1) 타입의 네트워크 아이디로 조회한 경우의 응답 예시는 다음과 같습니다.

{
    "content": {
        "networkId": 1630,
        "ordererId": "25728701",
        "ordererName": "test-orderer",
        "mspId": "test-msp",
        "ordererType": "Raft 1",
        "endpointAddr": "[test-orderer1-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com]",
        "adminIdentityName": "******-orderer",
        "ordererResourceCpu": 0.35,
        "ordererResourceMem": 700,
        "ordererResourceStorage": 200,
        "batchConfigTimeout": 0,
        "batchConfigMaxMessageCount": 0,
        "batchConfigPreferredMaxBytes": 0,
        "batchConfigAbsoluteMaxBytes": 0,
        "nodeAffinityLabel": "ncloud.com/nks-nodepool=test",
        "importYn": "N",
        "status": "ACTIVE",
        "consortiumList": [
            {
                "networkId": 1630,
                "networkName": "******-blockchain-test1",
                "mspId": "test-msp3",
                "mspName": "test-msp3",
                "importYn": "N"
            },
            {
                "networkId": 1630,
                "networkName": "******-blockchain-test1",
                "mspId": "test-msp2",
                "mspName": "test-msp2",
                "importYn": "N"
            },
            {
                "networkId": 1630,
                "networkName": "******-blockchain-test1",
                "mspId": "test-msp",
                "mspName": "test-msp",
                "importYn": "N"
            }
        ],
        "channelList": [
            {
                "networkId": 1630, 
                "ordererId": "25728701",
                "channelName": "test-channel",
                "operator": "test-msp"
            }
        ],
        "podStatus": [
            {
                "podStatus": "Running",
                "ordererResourceStorage": 200,
                "name": "test-orderer1",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            }
        ],
        "createDate": "2024-07-29T07:30:59+0000"
    }
}

다중 노드(Raft 5) 타입의 네트워크 아이디로 조회한 경우

다중 노드(Raft 5) 타입의 네트워크 아이디로 조회한 경우의 응답 예시는 다음과 같습니다.

{
    "content": {
        "networkId": 1630,
        "ordererId": "24739528",
        "ordererName": "test-orderer2",
        "mspId": "test-msp",
        "ordererType": "Raft 5",
        "endpointAddr": "[test-orderer25-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com,    test-orderer23-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com,   test-orderer21-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com,  test-orderer24-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com, test-orderer22-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com]",
        "adminIdentityName": "******-orderer",
        "ordererResourceCpu": 0.35,
        "ordererResourceMem": 700,
        "ordererResourceStorage": 100,
        "batchConfigTimeout": 0,
        "batchConfigMaxMessageCount": 0,
        "batchConfigPreferredMaxBytes": 0,
        "batchConfigAbsoluteMaxBytes": 0,
        "nodeAffinityLabel": "",
        "importYn": "N",
        "status": "ACTIVE",
        "consortiumList": [],
        "channelList": [],
        "podStatus": [
            {
                "podStatus": "Running",
                "ordererResourceStorage": 100,
                "name": "test-orderer21",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            },
            {
                "podStatus": "Running",
                "ordererResourceStorage": 100,
                "name": "test-orderer22",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            },
            {
                "podStatus": "Running",
                "ordererResourceStorage": 100,
                "name": "test-orderer23",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            },
            {
                "podStatus": "Running",
                "ordererResourceStorage": 100,
                "name": "test-orderer24",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            },
            {
                "podStatus": "Running",
                "ordererResourceStorage": 100,
                "name": "test-orderer25",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            }
        ],
        "createDate": "2024-07-31T02:11:51+0000"
    }
}

가져온 네트워크 아이디로 조회한 경우

가져온 네트워크 아이디로 조회한 경우의 응답 예시는 다음과 같습니다.

{
    "content": {
        "networkId": 1633,
        "ordererId": "1633orderer25utfaj",
        "ordererName": "orderer2",
        "ordererType": "Raft 1",
        "endpointAddr": "[orderer21-ydmzwr-hlf-ord.bc-yxvftpy7.kr.blockchain.naverncp.com]",
        "exportNetworkId": 1634,
        "exportOrdererId": "25869834",
        "ordererResourceCpu": 0.0,
        "ordererResourceMem": 0,
        "ordererResourceStorage": 0,
        "batchConfigTimeout": 0,
        "batchConfigMaxMessageCount": 0,
        "batchConfigPreferredMaxBytes": 0,
        "batchConfigAbsoluteMaxBytes": 0,
        "importYn": "Y",
        "status": "ACTIVE"
    }
}