VPC環境で利用できます。
ブロックチェーンネットワークのリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /api/v1/networks (韓国リージョン) |
| GET | /api/sgn-v1/networks (シンガポールリージョン) |
リクエストヘッダ
Blockchain Service APIで共通して使用されるヘッダの詳細は、Blockchain Serviceのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
page |
Integer | Optional | ページ番号
|
size |
Integer | Optional | 照会結果リストのサイズ
|
sort |
String | Optional | ソートの基準
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks?page=0&size=20&sort=networkName' \
--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'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
content |
Array | - | Contentの詳細情報: content |
totalElements |
Long | - | ブロックチェーンネットワークの総数 |
totalPages |
Integer | - | ページの総数 |
content
contentの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
networkId |
Long | - | ネットワーク ID |
networkName |
String | - | ネットワーク名 |
nksClusterName |
String | - | Ncloud Kubernetes Serviceクラスタ名 |
status |
String | - | ネットワークの状態
|
createDate |
LocalDateTime | - | ネットワークの作成日時
|
updateDate |
LocalDateTime | - | ネットワークの更新日時
|
レスポンスステータスコード
Blockchain Service APIで共通して使用されるレスポンスステータスコードの詳細は、Blockchain Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"content": [
{
"networkId": 1630,
"networkName": "******-blockchain-test1",
"nksClusterName": "blockchain-test (1.28.10)",
"status": "ACTIVE",
"createDate": "2024-07-29T07:25:39+0000",
"updateDate": "2024-07-29T07:30:59+0000"
},
{
"networkId": 1635,
"networkName": "******-blockchain-test2",
"nksClusterName": "blockchain-test (1.28.10)",
"status": "DEPLOY",
"createDate": "2024-08-06T06:27:24+0000",
"updateDate": "2024-08-06T06:27:24+0000"
}
],
"totalElements": 2,
"totalPages": 1
}