MENU
      Get organization information

        Get organization information


        Article summary

        Available in VPC

        Get the organization details of a blockchain network.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        GET/networks/{networkId}/organizations/{mspId}

        Request headers

        For headers common to all Blockchain Service APIs, see Common Blockchain Service headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        networkIdLongRequiredNetwork ID
        mspIdStringRequiredOrganization MSP ID

        Request example

        The following is a sample request.

        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'
        Shell

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        contentObject-Organization details
        content.mspIdString-Organization MSP ID
        content.mspNameString-Organization MSP name
        content.importYnBoolean-Organization MSP import status
        • Y | N (default)
          • Y: organization MSP imported from another network
          • N: organization MSP in the current network
        exportNetworkIdLong-Network ID imported from another network
        • It is displayed when importYn is Y
        content.networkIdLong-Network ID
        content.nodeListArray-nodeList details
        content.consortiumListArray-consortiumList details

        nodeList

        The following describes content.nodeList.

        FieldTypeRequiredDescription
        nodeNameString-Node name
        nodeTypeString-Node type
        • orderer | peer | CA
          • orderer: Manage channel configuration information within the network
          • peer: Maintain the network and handle transactions
          • CA: Issue and manage certificates in the network
        statusString-Node status
        • ACTIVE | DEPLOY | DELETE
          • ACTIVE: running
          • DEPLOY: deploying
          • DELETE: deleting

        consortiumList

        The following describes content.consortiumList.

        FieldTypeRequiredDescription
        roleString-Role of the consortium user
        • operator | participant
          • operator: Manage and operate the network
          • participant: Participate in the network
        ordererMspString-Orderer MSP name with consortium
        channelNameString-Name of the channel included in the consortium
        ordererNameString-Orderer name with consortium

        Response status codes

        For response status codes common to all Blockchain Service APIs, see Common Blockchain Service response status codes.

        Response example

        The following is a sample example.

        When querying with current network ID

        The following is a sample response when querying with the current network ID.

        {
            "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"
                    }
                ]
            }
        }
        JSON

        When querying with imported network ID

        The following is a sample response when querying with an imported network ID.

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

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.