Update Orderer Node Configuration
patch
/console/admin/api/v2/nodes/orderers/{ordererId}
An orderer node's configuration determines how the node performs and behaves on the network. Use this endpoint to modify an orderer node's configuration.
Request
Supported Media Types
- application/json
Path Parameters
-
ordererId(required): string
ID of orderer
Updated orderer attributes
Root Schema : setOrdererAttributes
Type:
Show Source
object-
batchSizeAbsMaxBytes:
integer
Default Value:
102760448Example:102760448 -
batchSizeMaxMessageCount:
integer
Default Value:
10Example:10 -
batchSizePrefMaxBytes:
integer
Default Value:
524288Example:524288 -
batchTimeout:
string
Default Value:
2sExample:2s -
kafkaRetry:
object orderKafkaRetry
Orderer attributes in Kafka mode
-
logLevel:
string
Allowed Values:
[ "DEBUG", "FATAL", "ERROR", "WARNING", "TRACE", "INFO" ] -
raftRetry:
object orderRaftRetry
Orderer attributes in Raft mode
Nested Schema : orderKafkaRetry
Type:
objectOrderer attributes in Kafka mode
Show Source
-
consumerRetryBackoff:
integer
Default Value:
2Example:2 -
longInterval:
integer
Default Value:
5Example:5 -
longTotal:
integer
Default Value:
10Example:10 -
metadataRetryBackoff:
integer
Default Value:
250Example:250 -
metadataRetryMax:
integer
Default Value:
3Example:3 -
networkDialTimeout:
integer
Default Value:
10Example:10 -
networkReadTimeout:
integer
Default Value:
10Example:10 -
networkWriteTimeout:
integer
Default Value:
10Example:10 -
producerRetryBackoff:
integer
Default Value:
100Example:100 -
producerRetryMax:
integer
Default Value:
3Example:3 -
shortInterval:
integer
Default Value:
5Example:5 -
shortTotal:
integer
Default Value:
10Example:10
Nested Schema : orderRaftRetry
Type:
objectOrderer attributes in Raft mode
Show Source
-
dialTimeout:
integer
Default Value:
5Example:5 -
evictionSuspicion:
integer
Default Value:
10Example:10 -
replicationBackgroundRefreshInterval:
integer
Default Value:
5Example:5 -
replicationBufferSize:
integer
Default Value:
20971520Example:20971520 -
replicationPullTimeout:
integer
Default Value:
5Example:5 -
replicationRetryTimeout:
integer
Default Value:
5Example:5 -
RPCTimeout:
integer
Default Value:
7Example:7 -
sendBufferSize:
integer
Default Value:
10Example:10
Response
Supported Media Types
- application/json
200 Response
Update success message
Root Schema : schema
Type:
objectExample:
{
"status":"Success",
"message":"content"
}400 Response
Invalid argument
401 Response
Unauthorized
403 Response
Forbidden
500 Response
Internal server error