Get peer list
- Print
- PDF
Get peer list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Get the list of peers that maintain the blockchain network and manage the ledger and chaincode.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /networks/{networkId}/peers |
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
|
size | Integer | Optional | Size of list viewed
|
Request example
The following is a sample request.
curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks/{networkId}/peers' \
--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 peer nodes |
totalPages | Integer | - | Total number of pages |
content
The following describes content.
| Field | Type | Required | Description |
|---|---|---|---|
networkId | Long | - | Network ID |
peerId | String | - | Peer ID |
peerName | String | - | Peer name |
statusDatabaseType | String | - | Peer's state database type
|
mspId | String | - | Peer MSP ID |
status | String | - | Peer status
|
createDate | LocalDateTime | - | Peer creation date and time (YYYY-MM-DDTHH:MM:SS+0000) |
updateDate | LocalDateTime | - | Peer modification 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": 1630,
"peerId": "25738634",
"peerName": "test-peer2",
"statusDatabaseType": "LEVEL_DB",
"mspId": "test-msp",
"status": "ACTIVE",
"createDate": "2024-07-30T00:29:32+0000",
"updateDate": "2024-08-08T16:29:32+0000"
}
],
"totalElements": 1,
"totalPages": 1
}
Was this article helpful?