Jump to

• Request
• Response

Update Orderer Node Configuration

patch

/console/admin/api/v1.1/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: string
  ID of orderer

Body ()

Updated orderer attributes

Root Schema : setOrdererAttributes

Type: object

Show Source

• batchSizeAbsMaxBytes(optional): integer
  Default Value: 102760448

  Example: 102760448
• batchSizeMaxMessageCount(optional): integer
  Default Value: 10

  Example: 10
• batchSizePrefMaxBytes(optional): integer
  Default Value: 524288

  Example: 524288
• batchTimeout(optional): string
  Default Value: 2s

  Example: 2s
• kafkaRetry(optional): object orderKafkaRetry
  Orderer attributes when using Kafka
• logLevel(optional): string
  Allowed Values: [ "DEBUG", "FATAL", "ERROR", "WARNING", "TRACE", "INFO" ]
• raftRetry(optional): object orderRaftRetry
  Orderer attributes when using 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"
        }
    }
}

Nested Schema : orderKafkaRetry

Type: object

Orderer attributes when using Kafka

Show Source

• consumerRetryBackoff(optional): integer
  Default Value: 2

  Example: 2
• longInterval(optional): integer
  Default Value: 5

  Example: 5
• longTotal(optional): integer
  Default Value: 10

  Example: 10
• metadataRetryBackoff(optional): integer
  Default Value: 250

  Example: 250
• metadataRetryMax(optional): integer
  Default Value: 3

  Example: 3
• networkDialTimeout(optional): integer
  Default Value: 10

  Example: 10
• networkReadTimeout(optional): integer
  Default Value: 10

  Example: 10
• networkWriteTimeout(optional): integer
  Default Value: 10

  Example: 10
• producerRetryBackoff(optional): integer
  Default Value: 100

  Example: 100
• producerRetryMax(optional): integer
  Default Value: 3

  Example: 3
• shortInterval(optional): integer
  Default Value: 5

  Example: 5
• shortTotal(optional): integer
  Default Value: 10

  Example: 10

{
    "type":"object",
    "description":"Orderer attributes when using Kafka",
    "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
        }
    }
}

Nested Schema : orderRaftRetry

Type: object

Orderer attributes when using Raft

Show Source

• dialTimeout(optional): integer
  Default Value: 5

  Example: 5
• evictionSuspicion(optional): integer
  Default Value: 10

  Example: 10
• replicationBackgroundRefreshInterval(optional): integer
  Default Value: 5

  Example: 5
• replicationBufferSize(optional): integer
  Default Value: 20971520

  Example: 20971520
• replicationPullTimeout(optional): integer
  Default Value: 5

  Example: 5
• replicationRetryTimeout(optional): integer
  Default Value: 5

  Example: 5
• RPCTimeout(optional): integer
  Default Value: 7

  Example: 7
• sendBufferSize(optional): integer
  Default Value: 10

  Example: 10

{
    "type":"object",
    "description":"Orderer attributes when using Raft",
    "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
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Update success message

Body ()

Root Schema : schema

Type: object

Example:

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

400 Response

Invalid argument

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

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

Example:

{
    "respMesg":"invalid argument"
}

401 Response

Unauthorized

403 Response

Forbidden

500 Response

Internal Server Error

Body ()

Root Schema : 500errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

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

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top