Peerリストの照会

Prev Next

VPC環境で利用できます。

ブロックチェーンネットワークを維持して台帳とチェーンコードを管理する Peerリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド タイプ 必須の有無 説明
page Integer Optional ページ番号
  • 0(デフォルト)
size Integer Optional 照会結果リストのサイズ
  • 20(デフォルト)

リクエスト例

リクエストのサンプルコードは次の通りです。

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'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
content Array - Contentの詳細情報
totalElements Long - Peerノードの総数
totalPages Integer - ページの総数

content

contentの説明は次の通りです。

フィールド タイプ 必須の有無 説明
networkId Long - ネットワーク ID
peerId String - Peer ID
peerName String - Peer名
statusDatabaseType String - Peerの Stateデータベースタイプ
  • LEVEL_DB | COUCH_DB
    • LEVEL_DB: 高いパフォーマンスと簡単なデータ構造をサポートする軽量 DB
    • COUCH_DB: JSONデータと複雑なクエリ、検索機能を提供する文書ベースの DB
mspId String - Peer MSP ID
status String - Peerの状態
  • ACTIVE | DEPLOY | DELETE
    • ACTIVE: 運用中
    • DEPLOY: デプロイ中
    • DELETE: 削除中
createDate LocalDateTime - Peerの作成日時(YYYY-MM-DDTHH:MM:SS+0000)
updateDate LocalDateTime - Peerの更新日時(YYYY-MM-DDTHH:MM:SS+0000)

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

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

レスポンス例

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

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