MENU
      Get orderer list

        Get orderer list


        Article summary

        Available in VPC

        Get the list of orderers that manage configuration information for channels in a blockchain network.

        Request

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

        MethodURI
        GET/networks/{networkId}/orderers

        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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        pageIntegerOptionalPage number
        • 0 (default)
        sizeIntegerOptionalSize of list viewed
        • 20 (default)

        Request example

        The following is a sample request.

        curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks/{networkId}/orderers?page=0&size=10' \
        --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
        contentArray-Content details
        totalElementsLong-Total number of orderer nodes
        totalPagesInteger-Total number of pages

        content

        The following describes content.

        FieldTypeRequiredDescription
        networkIdLong-Network ID
        ordererIdString-Orderer ID
        ordererNameString-Orderer name
        ordererTypeString-Orderer configuration type
        • Raft 1 | Raft 5
          • Raft 1: single node
          • Raft 5: multiple nodes
        importYnBoolean-Orderer MSP import status
        • Y | N (default)
          • Y: orderer MSP imported from another network
          • N: orderer MSP in the current network
        statusString-Orderer status
        • ACTIVE | DEPLOY | DELETE
          • ACTIVE: running
          • DEPLOY: deploying
          • DELETE: deleting
        createDateLocalDateTime-Orderer creation date and time (YYYY-MM-DDTHH:MM:SS+0000)

        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.

        {
            "content": [
                {
                    "networkId": 1633,
                    "ordererId": "1633orderer25utfaj",
                    "ordererName": "orderer2",
                    "ordererType": "Raft 1",
                    "importYn": "Y",
                    "status": "ACTIVE",
                    "createDate": "2024-08-07T01:40:52+0000"
                },
                {
                    "networkId": 1633,
                    "ordererId": "25869632",
                    "ordererName": "orderer1",
                    "ordererType": "Raft 1",
                    "importYn": "N",
                    "status": "ACTIVE",
                    "createDate": "2024-08-06T01:40:32+0000"
                }
            ],
            "totalElements": 2,
            "totalPages": 1
        }
        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.