Available in VPC
Blockchain Service is a NAVER Cloud Platform service that allows you to organize a private, consortium-style blockchain network using Hyperledger Fabric. The Blockchain Service provides APIs for component information of the blockchain network in RESTful form.
Common Blockchain Service settings
The following describes commonly used request and response formats in Blockchain Service APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows.
https://blockchainservice.apigw.ntruss.com
Request headers
The following describes the request headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
|
x-ncp-iam-access-key |
Required | Access key issued on NAVER Cloud Platform
|
x-ncp-apigw-signature-v2 |
Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
|
Content-type |
Required | Request data format
|
Response
The following describes the common response format.
Response body
The following describes the body.
| Field | Type | Required | Description |
|---|---|---|---|
errorCode |
String | - | Blockchain Service response status code |
message |
String | - | Response status code message |
status |
String | - | HTTP response status code name |
resources |
Array | - | List of required permissions for sub-permission errors |
Response status codes
Blockchain Service uses NAVER Cloud Platform's common response status codes. For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Response syntax
The response syntax is as follows.
{
"error":
{
"errorCode": "string",
"message": "string",
"status": "string",
"resources": []
}
}
Blockchain Service API
The following describes the APIs provided by Blockchain Service.
| API | Description |
|---|---|
| Get network list | Get blockchain network list |
| Get network information | Get blockchain network details |
| Get organization list | Get organization list |
| Get organization information | Get organization details |
| Download organization connection information | Download organization connection information as a JSON file |
| Get orderer list | Get orderer list |
| Get orderer information | Get orderer details |
| Download orderer connection information | Download orderer connection information as a JSON file |
| Get orderer pod log | Get orderer pod log |
| Get orderer pod usage | Get resource (CPU, memory, storage) usage for orderer pods |
| Get peer list | Get peer list |
| Get peer information | Get peer details |
| Get peer pod log | Get peer pod log |
| Get peer pod usage | Get resource (CPU, memory, storage) usage for peer pods |
| Get CA list | Get CA list |
| Get CA information | Get CA details |
| Get CA identity | Get CA user identity list and details |
| Download CA identity | Download the certificate and key for CA Identity as a JSON file |
| Get CA pod log | Get CA pod log |
| Get CA pod usage | Get resource (CPU, memory, storage) usage for CA pods |
Blockchain Service related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand Blockchain Service APIs.
- Blockchain Service API guides
- Sub Account User Guide: how to issue and check access keys for sub accounts issued by NAVER Cloud Platform
- Create signature: how to create a signature required for the request header
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the Blockchain Service service
- How to use the Blockchain Service
- Blockchain Service User Guide: how to use Blockchain Service in the NAVER Cloud Platform console
- Ncloud use environment guide: guide for VPC and Classic environments and support availability
- Introduction to pricing, characteristics, and detailed features: the summary of pricing system, characteristics, and detailed features of Blockchain Service
- Latest service news: the latest news on Blockchain Service
- FAQ: frequently asked questions from Blockchain Service users
- Contact us: Send direct inquiries in case of any unresolved questions that aren't answered by the user guides.