Get orderer list

Prev Next

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:

Method URI
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.

Field Type Required Description
networkId Long Required Network ID

Request query parameters

The following describes the parameters.

Field Type Required Description
page Integer Optional Page number
  • 0 (default)
size Integer Optional Size 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'

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Required Description
content Array - Content details
totalElements Long - Total number of orderer nodes
totalPages Integer - Total number of pages

content

The following describes content.

Field Type Required Description
networkId Long - Network ID
ordererId String - Orderer ID
ordererName String - Orderer name
ordererType String - Orderer configuration type
  • Raft 1 | Raft 5
    • Raft 1: single node
    • Raft 5: multiple nodes
importYn Boolean - Orderer MSP import status
  • Y | N (default)
    • Y: orderer MSP imported from another network
    • N: orderer MSP in the current network
status String - Orderer status
  • ACTIVE | DEPLOY | DELETE
    • ACTIVE: running
    • DEPLOY: deploying
    • DELETE: deleting
createDate LocalDateTime - 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
}