Orderer情報の照会

印刷する
共有
PDF

Orderer情報の照会

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`networkId`	Long	Required	ネットワーク ID Networkリストの照会を通じて確認
`ordererId`	String	Required	Orderer ID Ordererリストの照会を通じて確認

リクエスト例

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

curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks/{networkId}/orderers/{ordererId}' \
--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	-	Ordererの詳細情報
`content.networkId`	Long	-	ネットワーク ID
`content.ordererId`	String	-	Orderer ID
`content.ordererName`	String	-	Orderer名
`content.mspId`	String	-	Orderer MSP ID
`content.ordererType`	String	-	Ordererの構成タイプ `Raft 1` \| `Raft 5` `Raft 1`: 単一ノード(Single) `Raft 5`: マルチノード(Multiple)
`content.endpointAddr`	Array<String>	-	Orderer URLアドレス
`content.adminIdentityName`	String	-	Admin Orderer CA名
`content.exportNetworkId`	Long	-	他のネットワークからインポートしたネットワーク ID `importYn`が`Y`の場合に表示
`content.exportOrdererId`	String	-	他のネットワークからインポートした Orderer ID `importYn`が`Y`の場合に表示
`content.ordererResourceCpu`	Float	-	Orderer Podに割り当てられた CPU容量(単位: core)
`content.ordererResourceMem`	Integer	-	Orderer Podに割り当てられた Memory容量(単位: MB)
`content.ordererResourceStorage`	Integer	-	Orderer Podに割り当てられた Storage容量(単位: MiB)
`content.batchConfigTimeout`	Integer	-	トランザクションを集めてブロックを作成する間隔(単位: 秒) 0(デフォルト)
`content.batchConfigMaxMessageCount`	Integer	-	ブロック作成時に含める最大トランザクション数(単位: 個) 0(デフォルト)
`content.batchConfigPreferredMaxBytes`	Integer	-	ブロック作成時の最大サイズ(単位: MB) 0(デフォルト)
`content.batchConfigAbsoluteMaxBytes`	Integer	-	ブロック作成時の基準となる最大サイズ(単位: MB) 0(デフォルト)
`content.nodeAffinityLabel`	String	-	Ordererノードが配置された Ncloud Kubernetes Serviceクラスタノードプールのラベル名
`content.importYn`	Boolean	-	Orderer MSPインポート(Import)の有無 `Y` \| `N`(デフォルト) `Y`: 他のネットワークからインポートした Orderer MSP `N`: 現在のネットワークの Orderer MSP
`content.status`	String	-	Ordererの状態 `ACTIVE` \| `DEPLOY` \| `DELETE` `ACTIVE`: 運用中 `DEPLOY`: デプロイ中 `DELETE`: 削除中
`content.consortiumList`	Array	-	consortiumListの詳細情報
`content.channelList`	Array	-	channelListの詳細情報
`content.podStatus`	Array	-	podStatusの詳細情報
`content.createDate`	LocalDateTime	-	Ordererの作成日時(YYYY-MM-DDTHH:MM:SS+0000)

`consortiumList`

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

フィールド	タイプ	必須の有無	説明
`networkId`	Long	-	コンソーシアムが構成されたネットワーク ID
`networkName`	String	-	コンソーシアムが構成されたネットワーク名
`mspId`	String	-	コンソーシアムが構成された MSP ID
`mspName`	String	-	コンソーシアムが構成された MSP名
`importYn`	Boolean	-	Orderer MSPインポート(Import)の有無 `Y` \| `N`(デフォルト) `Y`: 他のネットワークからインポートした Orderer MSP `N`: 現在のネットワークの Orderer MSP

`channelList`

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

フィールド	タイプ	必須の有無	説明
`networkId`	Long	-	チャンネルが作成されたネットワーク ID
`ordererId`	String	-	チャンネルが作成された Orderer ID
`channelName`	String	-	チャンネル名
`operator`	String	-	チャンネル Operator名

`podStatus`

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

フィールド	タイプ	必須の有無	説明
`podStatus`	String	-	Orderer Podのライフサイクル(Lifecycle)段階 `Running` \| `Pending` \| `Failed` \| `Unknown` `Running`: 実行中 `Pending`: 待機中 `Failed`: 動作失敗 `Unknown`: 状態確認不可
`ordererResourceStorage`	Integer	-	Orderer Podに割り当てられた Storage容量(単位: MiB)
`name`	String	-	Orderer Pod名
`ordererResourceMem`	Integer	-	Orderer Podに割り当てられた Memory容量(単位: MB)
`ordererResourceCpu`	Integer	-	Orderer Podに割り当てられた CPU容量(単位: core)

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

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

レスポンス例

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

単一ノード(`Raft 1`)タイプのネットワーク IDで照会した場合

単一ノード(Raft 1)タイプのネットワーク IDで照会した場合のレスポンスのサンプルコードは次の通りです。

{
    "content": {
        "networkId": 1630,
        "ordererId": "25728701",
        "ordererName": "test-orderer",
        "mspId": "test-msp",
        "ordererType": "Raft 1",
        "endpointAddr": "[test-orderer1-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com]",
        "adminIdentityName": "******-orderer",
        "ordererResourceCpu": 0.35,
        "ordererResourceMem": 700,
        "ordererResourceStorage": 200,
        "batchConfigTimeout": 0,
        "batchConfigMaxMessageCount": 0,
        "batchConfigPreferredMaxBytes": 0,
        "batchConfigAbsoluteMaxBytes": 0,
        "nodeAffinityLabel": "ncloud.com/nks-nodepool=test",
        "importYn": "N",
        "status": "ACTIVE",
        "consortiumList": [
            {
                "networkId": 1630,
                "networkName": "******-blockchain-test1",
                "mspId": "test-msp3",
                "mspName": "test-msp3",
                "importYn": "N"
            },
            {
                "networkId": 1630,
                "networkName": "******-blockchain-test1",
                "mspId": "test-msp2",
                "mspName": "test-msp2",
                "importYn": "N"
            },
            {
                "networkId": 1630,
                "networkName": "******-blockchain-test1",
                "mspId": "test-msp",
                "mspName": "test-msp",
                "importYn": "N"
            }
        ],
        "channelList": [
            {
                "networkId": 1630, 
                "ordererId": "25728701",
                "channelName": "test-channel",
                "operator": "test-msp"
            }
        ],
        "podStatus": [
            {
                "podStatus": "Running",
                "ordererResourceStorage": 200,
                "name": "test-orderer1",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            }
        ],
        "createDate": "2024-07-29T07:30:59+0000"
    }
}

マルチノード(`Raft 5`)タイプのネットワーク IDで照会した場合

マルチノード(Raft 5)タイプのネットワーク IDで照会した場合のレスポンスのサンプルコードは次の通りです。

{
    "content": {
        "networkId": 1630,
        "ordererId": "24739528",
        "ordererName": "test-orderer2",
        "mspId": "test-msp",
        "ordererType": "Raft 5",
        "endpointAddr": "[test-orderer25-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com,    test-orderer23-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com,   test-orderer21-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com,  test-orderer24-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com, test-orderer22-******-***-ord.bc-gryy4rew.kr.blockchain.naverncp.com]",
        "adminIdentityName": "******-orderer",
        "ordererResourceCpu": 0.35,
        "ordererResourceMem": 700,
        "ordererResourceStorage": 100,
        "batchConfigTimeout": 0,
        "batchConfigMaxMessageCount": 0,
        "batchConfigPreferredMaxBytes": 0,
        "batchConfigAbsoluteMaxBytes": 0,
        "nodeAffinityLabel": "",
        "importYn": "N",
        "status": "ACTIVE",
        "consortiumList": [],
        "channelList": [],
        "podStatus": [
            {
                "podStatus": "Running",
                "ordererResourceStorage": 100,
                "name": "test-orderer21",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            },
            {
                "podStatus": "Running",
                "ordererResourceStorage": 100,
                "name": "test-orderer22",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            },
            {
                "podStatus": "Running",
                "ordererResourceStorage": 100,
                "name": "test-orderer23",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            },
            {
                "podStatus": "Running",
                "ordererResourceStorage": 100,
                "name": "test-orderer24",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            },
            {
                "podStatus": "Running",
                "ordererResourceStorage": 100,
                "name": "test-orderer25",
                "ordererResourceMem": 700,
                "ordererResourceCpu": 0.35
            }
        ],
        "createDate": "2024-07-31T02:11:51+0000"
    }
}

インポートしたネットワーク IDで照会した場合

インポートしたネットワーク IDで照会した場合のレスポンスのサンプルコードは次の通りです。

{
    "content": {
        "networkId": 1633,
        "ordererId": "1633orderer25utfaj",
        "ordererName": "orderer2",
        "ordererType": "Raft 1",
        "endpointAddr": "[orderer21-ydmzwr-hlf-ord.bc-yxvftpy7.kr.blockchain.naverncp.com]",
        "exportNetworkId": 1634,
        "exportOrdererId": "25869834",
        "ordererResourceCpu": 0.0,
        "ordererResourceMem": 0,
        "ordererResourceStorage": 0,
        "batchConfigTimeout": 0,
        "batchConfigMaxMessageCount": 0,
        "batchConfigPreferredMaxBytes": 0,
        "batchConfigAbsoluteMaxBytes": 0,
        "importYn": "Y",
        "status": "ACTIVE"
    }
}

この記事は役に立ちましたか?

What's Next

Orderer接続情報のダウンロード

リクエスト
レスポンス

タグ

Blockchain Service

Orderer情報の照会

リクエスト

リクエストヘッダ

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

リクエスト例

レスポンス

レスポンスボディ

consortiumList

channelList

podStatus

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

レスポンス例

単一ノード(Raft 1)タイプのネットワーク IDで照会した場合

マルチノード(Raft 5)タイプのネットワーク IDで照会した場合

インポートしたネットワーク IDで照会した場合

What's Next

`consortiumList`

`channelList`

`podStatus`

単一ノード(`Raft 1`)タイプのネットワーク IDで照会した場合

マルチノード(`Raft 5`)タイプのネットワーク IDで照会した場合