リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks/{networkId}/orderers?page=0&size=10' \
--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	-	Ordererノードの総数
`totalPages`	Integer	-	ページの総数

`content`

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

フィールド	タイプ	必須の有無	説明
`networkId`	Long	-	ネットワーク ID
`ordererId`	String	-	Orderer ID
`ordererName`	String	-	Orderer名
`ordererType`	String	-	Ordererの構成タイプ `Raft 1` \| `Raft 5` `Raft 1`: 単一ノード(Single) `Raft 5`: マルチノード(Multiple)
`importYn`	Boolean	-	Orderer MSPインポート(Import)の有無 `Y` \| `N`(デフォルト) `Y`: 他のネットワークからインポートした Orderer MSP `N`: 現在のネットワークの Orderer MSP
`status`	String	-	Ordererの状態 `ACTIVE` \| `DEPLOY` \| `DELETE` `ACTIVE`: 運用中 `DEPLOY`: デプロイ中 `DELETE`: 削除中
`createDate`	LocalDateTime	-	Ordererの作成日時(YYYY-MM-DDTHH:MM:SS+0000)

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

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

レスポンス例

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

{
    "content": [
        {
            "networkId": 1633,
            "ordererId": "1633orderer25utfaj",
            "ordererName": "orderer2",
            "ordererType": "Raft 1",
            "importYn": "Y",
            "status": "ACTIVE",
            "createDate": "2024-08-07T01:40:52+0000"
        },
        {
            "networkId": 1633,
            "ordererId": "25869632",
            "ordererName": "orderer1",
            "ordererType": "Raft 1",
            "importYn": "N",
            "status": "ACTIVE",
            "createDate": "2024-08-06T01:40:32+0000"
        }
    ],
    "totalElements": 2,
    "totalPages": 1
}

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

リクエスト
レスポンス

タグ

Blockchain Service