Organization情報の照会

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks/{networkId}/organizations/{mspId}' \
--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	-	Organizationの詳細情報
`content.mspId`	String	-	Organization MSP ID
`content.mspName`	String	-	Organization MSP名
`content.importYn`	Boolean	-	Organization MSPインポート(Import)の有無 `Y` \| `N`(デフォルト) `Y`: 他のネットワークからインポートした Organization MSP `N`: 現在のネットワークの Organization MSP
`exportNetworkId`	Long	-	他のネットワークからインポートしたネットワーク ID `importYn`が`Y`の場合に表示
`content.networkId`	Long	-	ネットワーク ID
`content.nodeList`	Array	-	nodeListの詳細情報
`content.consortiumList`	Array	-	consortiumListの詳細情報

`nodeList`

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

フィールド	タイプ	必須の有無	説明
`nodeName`	String	-	ノード名
`nodeType`	String	-	ノードタイプ `orderer` \| `peer` \| `CA` `orderer`: ネットワーク内チャンネル構成情報を管理 `peer`: ネットワークの維持、トランザクション処理 `CA`: ネットワーク内証明書の発行・管理
`status`	String	-	ノードの状態 `ACTIVE` \| `DEPLOY` \| `DELETE` `ACTIVE`: 運用中 `DEPLOY`: デプロイ中 `DELETE`: 削除中

`consortiumList`

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

フィールド	タイプ	必須の有無	説明
`role`	String	-	コンソーシアムユーザーのロール `operator` \| `participant` `operator`: ネットワークの管理・運用 `participant`: ネットワークに参加
`ordererMsp`	String	-	コンソーシアムを持つ Orderer MSP名
`channelName`	String	-	コンソーシアムに含まれたチャンネル名
`ordererName`	String	-	コンソーシアムを持つ Orderer名

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

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

レスポンス例

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

現在のネットワーク IDで照会した場合

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

{
    "content": {
        "mspId": "test-msp",
        "mspName": "test-msp",
        "importYn": "N",
        "networkId": 1630,
        "nodeList": [
            {
                "nodeName": "test-peer2",
                "nodeType": "Peer",
                "status": "ACTIVE"
            },
            {
                "nodeName": "test-orderer",
                "nodeType": "Orderer",
                "status": "ACTIVE"
            },
            {
                "nodeName": "test-orderer2",
                "nodeType": "Orderer",
                "status": "ACTIVE"
            },
            {
                "nodeName": "test-orderer3",
                "nodeType": "Orderer",
                "status": "ACTIVE"
            },
            {
                "nodeName": "test-ca",
                "nodeType": "CA",
                "status": "ACTIVE"
            }
        ],
        "consortiumList": [
            {
                "role": "operator",
                "ordererMsp": "test-msp",
                "channelName": "test-channel",
                "ordererName": "test-orderer"
            }
        ]
    }
}

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

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

{
    "content": {
        "mspId": "orderer-msp1",
        "mspName": "orderer-msp1",
        "importYn": "Y",
        "exportNetworkId": 1633,
        "networkId": 1634,
        "nodeList": [],
        "consortiumList": []
    }
}

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

What's Next

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

リクエスト
レスポンス

タグ

Blockchain Service