Organizationリストの照会

Prev Next

VPC環境で利用できます。

ブロックチェーンネットワーク内 MSPを作成・管理する Organizationリストを照会します。

リクエスト

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

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

リクエストヘッダ

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}/organizations?page=0&size=20' \
--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 - Organizationの総数
totalPages Integer - ページの総数

content

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

フィールド タイプ 必須の有無 説明
mspId String - MSP ID
mspName String - MSP名
importYn Boolean - MSPインポート(Import)の有無
  • Y | N(デフォルト)
    • Y: 他のネットワークからインポートした MSP
    • N: 現在のネットワークの MSP
exportNetworkId Long - 他のネットワークからインポートしたネットワーク ID
  • importYnがYの場合に表示
networkId Long - ネットワーク ID

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

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

レスポンス例

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

{
    "content": [
        {
            "mspId": "orderer-msp1",
            "mspName": "orderer-msp1",
            "importYn": "Y",
            "exportNetworkId": 1633,
            "networkId": 1634
        },
        {
            "mspId": "orderer2-msp2",
            "mspName": "orderer2-msp2",
            "importYn": "N",
            "networkId": 1634
        },
        {
            "mspId": "peer2-msp2",
            "mspName": "peer2-msp2",
            "importYn": "N",
            "networkId": 1634
        }
    ],
    "totalElements": 3,
    "totalPages": 1
}