Jump to

• Request
• Response

Update Orderer Advanced Attributes for a Channel

patch

/console/admin/api/v2/channels/{channelName}/orderingSettings

Update orderer advanced attribute for a channel.

Request

Supported Media Types

• application/json

Path Parameters

• channelName: string
  the specified channel name

Body ()

New orderer attributes to be updated for this channel. Note that 'batchTimeout' should be specified with a string, such as '2s'

Root Schema : schema

Type: object

Show Source

• absoluteMessageBytes(optional): number
  Default Value: 98

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

  Example: 2s
• maxMessageCount(optional): number
  Default Value: 10

  Example: 10
• preferredMessageBytes(optional): number
  Default Value: 512

  Example: 512

{
    "type":"object",
    "properties":{
        "absoluteMessageBytes":{
            "type":"number",
            "default":98,
            "example":98
        },
        "maxMessageCount":{
            "type":"number",
            "default":10,
            "example":10
        },
        "preferredMessageBytes":{
            "type":"number",
            "default":512,
            "example":512
        },
        "batchTimeout":{
            "type":"string",
            "default":"2s",
            "example":"2s"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : 200successModels

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "status":"success"
    }
}

Example:

{
    "status":"success"
}

400 Response

Invalid arguments

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Resource not found

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"
        }
    }
}

Back to Top