移動

• リクエスト
• レスポンス

オーダラ・ノードの構成の更新

patch

/console/admin/api/v2/nodes/orderers/{ordererId}

オーダラ・ノードの構成により、ネットワーク上でのノードの挙動や動作が決まります。オーダラ・ノードの構成を変更するには、このエンドポイントを使用します。

リクエスト

サポートされるメディア・タイプ

• application/json

パス・パラメータ

• ordererId(必須): string
  オーダラのID

本文()

更新するオーダラ属性

ルート・スキーマ: setOrdererAttributes

型: object

ソースの表示

• batchSizeAbsMaxBytes: integer
  デフォルト値: 102760448

  例: 102760448
• batchSizeMaxMessageCount: integer
  デフォルト値: 10

  例: 10
• batchSizePrefMaxBytes: integer
  デフォルト値: 524288

  例: 524288
• batchTimeout: string
  デフォルト値: 2s

  例: 2s
• kafkaRetry: object orderKafkaRetry
  Kafkaモードのオーダラ属性
• logLevel: string
  許容値: [ "DEBUG", "FATAL", "ERROR", "WARNING", "TRACE", "INFO" ]
• raftRetry: object orderRaftRetry
  Raftモードのオーダラ属性

{
    "type":"object",
    "properties":{
        "batchTimeout":{
            "type":"string",
            "default":"2s",
            "example":"2s"
        },
        "batchSizeMaxMessageCount":{
            "type":"integer",
            "default":"10",
            "example":"10"
        },
        "batchSizeAbsMaxBytes":{
            "type":"integer",
            "default":"102760448",
            "example":"102760448"
        },
        "batchSizePrefMaxBytes":{
            "type":"integer",
            "default":"524288",
            "example":"524288"
        },
        "logLevel":{
            "$ref":"#/definitions/logLevel"
        },
        "kafkaRetry":{
            "$ref":"#/definitions/orderKafkaRetry"
        },
        "raftRetry":{
            "$ref":"#/definitions/orderRaftRetry"
        }
    }
}

ネストしたスキーマ: orderKafkaRetry

型: object

Kafkaモードのオーダラ属性

ソースの表示

• consumerRetryBackoff: integer
  デフォルト値: 2

  例: 2
• longInterval: integer
  デフォルト値: 5

  例: 5
• longTotal: integer
  デフォルト値: 10

  例: 10
• metadataRetryBackoff: integer
  デフォルト値: 250

  例: 250
• metadataRetryMax: integer
  デフォルト値: 3

  例: 3
• networkDialTimeout: integer
  デフォルト値: 10

  例: 10
• networkReadTimeout: integer
  デフォルト値: 10

  例: 10
• networkWriteTimeout: integer
  デフォルト値: 10

  例: 10
• producerRetryBackoff: integer
  デフォルト値: 100

  例: 100
• producerRetryMax: integer
  デフォルト値: 3

  例: 3
• shortInterval: integer
  デフォルト値: 5

  例: 5
• shortTotal: integer
  デフォルト値: 10

  例: 10

{
    "type":"object",
    "description":"Orderer attributes in Kafka mode",
    "properties":{
        "shortInterval":{
            "type":"integer",
            "default":"5",
            "example":"5"
        },
        "shortTotal":{
            "type":"integer",
            "default":"10",
            "example":"10"
        },
        "longInterval":{
            "type":"integer",
            "default":"5",
            "example":"5"
        },
        "longTotal":{
            "type":"integer",
            "default":"10",
            "example":"10"
        },
        "networkDialTimeout":{
            "type":"integer",
            "default":"10",
            "example":"10"
        },
        "networkReadTimeout":{
            "type":"integer",
            "default":"10",
            "example":"10"
        },
        "networkWriteTimeout":{
            "type":"integer",
            "default":"10",
            "example":"10"
        },
        "metadataRetryBackoff":{
            "type":"integer",
            "default":"250",
            "example":"250"
        },
        "metadataRetryMax":{
            "type":"integer",
            "default":"3",
            "example":"3"
        },
        "producerRetryBackoff":{
            "type":"integer",
            "default":"100",
            "example":"100"
        },
        "producerRetryMax":{
            "type":"integer",
            "default":"3",
            "example":"3"
        },
        "consumerRetryBackoff":{
            "type":"integer",
            "default":"2",
            "example":"2"
        }
    }
}

ネストしたスキーマ: orderRaftRetry

型: object

Raftモードのオーダラ属性

ソースの表示

• dialTimeout: integer
  デフォルト値: 5

  例: 5
• evictionSuspicion: integer
  デフォルト値: 10

  例: 10
• replicationBackgroundRefreshInterval: integer
  デフォルト値: 5

  例: 5
• replicationBufferSize: integer
  デフォルト値: 20971520

  例: 20971520
• replicationPullTimeout: integer
  デフォルト値: 5

  例: 5
• replicationRetryTimeout: integer
  デフォルト値: 5

  例: 5
• RPCTimeout: integer
  デフォルト値: 7

  例: 7
• sendBufferSize: integer
  デフォルト値: 10

  例: 10

{
    "type":"object",
    "description":"Orderer attributes in Raft mode",
    "properties":{
        "sendBufferSize":{
            "type":"integer",
            "default":"10",
            "example":"10"
        },
        "dialTimeout":{
            "type":"integer",
            "default":"5",
            "example":"5"
        },
        "RPCTimeout":{
            "type":"integer",
            "default":"7",
            "example":"7"
        },
        "replicationBufferSize":{
            "type":"integer",
            "default":"20971520",
            "example":"20971520"
        },
        "replicationBackgroundRefreshInterval":{
            "type":"integer",
            "default":"5",
            "example":"5"
        },
        "replicationRetryTimeout":{
            "type":"integer",
            "default":"5",
            "example":"5"
        },
        "replicationPullTimeout":{
            "type":"integer",
            "default":"5",
            "example":"5"
        },
        "evictionSuspicion":{
            "type":"integer",
            "default":"10",
            "example":"10"
        }
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

更新成功メッセージ

本文()

ルート・スキーマ: schema

型: object

例:

{
    "status":"Success",
    "message":"content"
}

400レスポンス

無効な引数

本文()

ルート・スキーマ: 400errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

例:

{
    "respMesg":"invalid argument"
}

401レスポンス

未認可

403レスポンス

禁止されています

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: 500errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

先頭に戻る