Organization 정보 조회

Prev Next

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

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

요청

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

메서드 URI
GET /networks/{networkId}/organizations/{mspId}

요청 헤더

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

요청 경로 파라미터

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

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

요청 예시

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

curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks/{networkId}/organizations/{mspId}' \
--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 - Organization 상세 정보
content.mspId String - Organization MSP 아이디
content.mspName String - Organization MSP 이름
content.importYn Boolean - Organization MSP 가져오기(Import) 여부
  • Y | N (기본값)
    • Y: 다른 네트워크에서 가져온 Organization MSP
    • N: 현재 네트워크의 Organization MSP
exportNetworkId Long - 다른 네트워크에서 가져온 네트워크 아이디
  • importYn이 Y일 때 표시
content.networkId Long - 네트워크 아이디
content.nodeList Array - nodeList 상세 정보
content.consortiumList Array - consortiumList 상세 정보

nodeList

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

필드 타입 필수 여부 설명
nodeName String - 노드 이름
nodeType String - 노드 타입
  • orderer | peer | CA
    • orderer: 네트워크 내 채널 구성 정보 관리
    • peer: 네트워크 유지 및 트랜잭션 처리
    • CA: 네트워크 내 인증서 발급 및 관리
status String - 노드 상태
  • ACTIVE | DEPLOY | DELETE
    • ACTIVE: 운영 중
    • DEPLOY: 배포 중
    • DELETE: 삭제 중

consortiumList

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

필드 타입 필수 여부 설명
role String - 컨소시엄 사용자의 역할
  • operator | participant
    • operator: 네트워크 관리 및 운영
    • participant: 네트워크 참여
ordererMsp String - 컨소시엄을 가진 Orderer MSP 이름
channelName String - 컨소시엄에 포함된 채널 이름
ordererName String - 컨소시엄을 가진 Orderer 이름

응답 상태 코드

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

응답 예시

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

현재 네트워크 아이디로 조회한 경우

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

{
    "content": {
        "mspId": "test-msp",
        "mspName": "test-msp",
        "importYn": "N",
        "networkId": 1630,
        "nodeList": [
            {
                "nodeName": "test-peer2",
                "nodeType": "Peer",
                "status": "ACTIVE"
            },
            {
                "nodeName": "test-orderer",
                "nodeType": "Orderer",
                "status": "ACTIVE"
            },
            {
                "nodeName": "test-orderer2",
                "nodeType": "Orderer",
                "status": "ACTIVE"
            },
            {
                "nodeName": "test-orderer3",
                "nodeType": "Orderer",
                "status": "ACTIVE"
            },
            {
                "nodeName": "test-ca",
                "nodeType": "CA",
                "status": "ACTIVE"
            }
        ],
        "consortiumList": [
            {
                "role": "operator",
                "ordererMsp": "test-msp",
                "channelName": "test-channel",
                "ordererName": "test-orderer"
            }
        ]
    }
}

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

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

{
    "content": {
        "mspId": "orderer-msp1",
        "mspName": "orderer-msp1",
        "importYn": "Y",
        "exportNetworkId": 1633,
        "networkId": 1634,
        "nodeList": [],
        "consortiumList": []
    }
}