Available in VPC
Get the blockchain network details.
Request
The following describes the request format for the endpoint. The request format is as follows:
Method | URI |
---|---|
GET | /networks/{networkId} |
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 example
curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks/{networkId}' \
--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 |
Object | - | Network details |
content.networkId |
Long | - | Network ID |
content.networkName |
String | - | Network name |
content.blockchainFrameworkCodeName |
String | - | Hyperledger Fabric version information |
content.nksClusterName |
String | - | Ncloud Kubernetes Service cluster name |
content.nodeAffinityLabel |
String | - | Label name of the Ncloud Kubernetes Service cluster nodepool where the blockchain node is deployed |
content.status |
String | - | Network status
|
content.peerCount |
Integer | - | Number of peer nodes |
content.ordererCount |
Integer | - | Number of orderer nodes |
content.channelCount |
Integer | - | Number of channel nodes |
content.createDate |
LocalDateTime | - | Network 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": 1630,
"networkName": "******-blockchain-test1",
"blockchainFrameworkCodeName": "Hyperledger Fabric 2.2.3",
"nksClusterName": "blockchain-test (1.28.10)",
"status": "ACTIVE",
"peerCount": 1,
"ordererCount": 1,
"channelCount": 1,
"createDate": "2024-07-29T07:25:39+0000"
}
}