Network情報の照会

Prev Next

VPC環境で利用できます。

ブロックチェーンネットワークの詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /networks/{networkId}

リクエストヘッダ

Blockchain Service APIで共通して使用されるヘッダの詳細は、Blockchain Serviceの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
networkId Long Required ネットワーク ID

リクエスト例

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'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
content Object - ネットワークの詳細情報
content.networkId Long - ネットワーク ID
content.networkName String - ネットワーク名
content.blockchainFrameworkCodeName String - Hyperledger Fabricバージョン情報
content.nksClusterName String - Ncloud Kubernetes Serviceクラスタ名
content.nodeAffinityLabel String - ブロックチェーンノードが配置された Ncloud Kubernetes Serviceクラスタノードプールのラベル名
content.status String - ネットワークの状態
  • ACTIVE | DEPLOY | DELETE
    • ACTIVE: 運用中
    • DEPLOY: デプロイ中
    • DELETE: 削除中
content.peerCount Integer - Peerノード数
content.ordererCount Integer - Ordererノード数
content.channelCount Integer - チャンネルノード数
content.createDate LocalDateTime - ネットワークの作成日時(YYYY-MM-DDTHH:MM:SS+0000)

レスポンスステータスコード

Blockchain Service APIで共通して使用されるレスポンスステータスコードの詳細は、Blockchain Serviceの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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"
    }
}