Jump to

• Request
• Response

Update Peer Node Configuration

patch

/console/admin/api/v2/nodes/peers/{peerId}

Use this endpoint to modify the configuration attributes of a peer.

Request

Supported Media Types

• application/json

Path Parameters

• peerId: string
  ID of peer to patch

Body ()

Updated peer attributes

Root Schema : peerPatchAttributes

Type: object

Show Source

• alias(optional): string
• chaincode(optional): object chaincode
• eventService(optional): object eventService
• gossip(optional): object gossip
• gossipElection(optional): object gossipElection
• logLevel(optional): string
  Allowed Values: [ "DEBUG", "FATAL", "ERROR", "WARNING", "TRACE", "INFO" ]

{
    "type":"object",
    "properties":{
        "alias":{
            "type":"string"
        },
        "logLevel":{
            "$ref":"#/definitions/logLevel"
        },
        "gossip":{
            "$ref":"#/definitions/gossip"
        },
        "gossipElection":{
            "type":"object",
            "properties":{
                "membershipSampleInterval":{
                    "type":"integer",
                    "default":1,
                    "example":1
                },
                "leaderALiveThreshold":{
                    "type":"integer",
                    "default":10,
                    "example":10
                },
                "leaderElectionDuration":{
                    "type":"integer",
                    "default":5,
                    "example":5
                },
                "leader":{
                    "type":"string",
                    "enum":[
                        "UseLeaderElection",
                        "OrgLeader"
                    ]
                }
            }
        },
        "eventService":{
            "type":"object",
            "properties":{
                "bufferSize":{
                    "type":"integer",
                    "default":100,
                    "example":100
                },
                "timeout":{
                    "type":"integer",
                    "default":10,
                    "example":10
                }
            }
        },
        "chaincode":{
            "type":"object",
            "properties":{
                "startupTimeout":{
                    "type":"integer",
                    "default":300,
                    "example":300
                },
                "installTimeout":{
                    "type":"integer",
                    "default":300,
                    "example":300
                },
                "executeTimeout":{
                    "type":"integer",
                    "default":30,
                    "example":30
                },
                "mode":{
                    "type":"string",
                    "enum":[
                        "dev",
                        "net"
                    ]
                },
                "keepalive":{
                    "type":"integer"
                },
                "logLevel":{
                    "$ref":"#/definitions/logLevel"
                },
                "shimLevel":{
                    "$ref":"#/definitions/logLevel"
                }
            }
        }
    }
}

Nested Schema : chaincode

Type: object

Show Source

• executeTimeout(optional): integer
  Default Value: 30

  Example: 30
• installTimeout(optional): integer
  Default Value: 300

  Example: 300
• keepalive(optional): integer
• logLevel(optional): string
  Allowed Values: [ "DEBUG", "FATAL", "ERROR", "WARNING", "TRACE", "INFO" ]
• mode(optional): string
  Allowed Values: [ "dev", "net" ]
• shimLevel(optional): string
  Allowed Values: [ "DEBUG", "FATAL", "ERROR", "WARNING", "TRACE", "INFO" ]
• startupTimeout(optional): integer
  Default Value: 300

  Example: 300

{
    "type":"object",
    "properties":{
        "startupTimeout":{
            "type":"integer",
            "default":300,
            "example":300
        },
        "installTimeout":{
            "type":"integer",
            "default":300,
            "example":300
        },
        "executeTimeout":{
            "type":"integer",
            "default":30,
            "example":30
        },
        "mode":{
            "type":"string",
            "enum":[
                "dev",
                "net"
            ]
        },
        "keepalive":{
            "type":"integer"
        },
        "logLevel":{
            "$ref":"#/definitions/logLevel"
        },
        "shimLevel":{
            "$ref":"#/definitions/logLevel"
        }
    }
}

Nested Schema : eventService

Type: object

Show Source

• bufferSize(optional): integer
  Default Value: 100

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

  Example: 10

{
    "type":"object",
    "properties":{
        "bufferSize":{
            "type":"integer",
            "default":100,
            "example":100
        },
        "timeout":{
            "type":"integer",
            "default":10,
            "example":10
        }
    }
}

Nested Schema : gossip

Type: object

Show Source

• aliveExpirationTimeout(optional): integer
  Default Value: 25

  Example: 25
• aliveTimeInterval(optional): integer
  Default Value: 5

  Example: 5
• bootstrapPeers(optional): string
• connectTimeout(optional): integer
  Default Value: 2

  Example: 2
• dialTimeout(optional): integer
  Default Value: 3

  Example: 3
• digestWaitTime(optional): integer
  Default Value: 1

  Example: 1
• maxBlockCountToStore(optional): integer
  Default Value: 100

  Example: 100
• maxConnectionAttempts(optional): integer
  Default Value: 120

  Example: 120
• maxPropagationBurstLatency(optional): integer
  Default Value: 10

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

  Example: 10
• msgExpirationFactor(optional): integer
  Default Value: 20

  Example: 20
• propagateIterations(optional): integer
  Default Value: 1

  Example: 1
• propagatePeerNumber(optional): integer
  Default Value: 3

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

  Example: 10
• publishStateInfo(optional): integer
  Default Value: 4

  Example: 4
• pullInterval(optional): integer
  Default Value: 4

  Example: 4
• pullPeerNumber(optional): integer
  Default Value: 3

  Example: 3
• receiveBufferSize(optional): integer
  Default Value: 20

  Example: 20
• reconnectInterval(optional): integer
  Default Value: 25

  Example: 25
• requestStateInfoInterval(optional): integer
  Default Value: 4

  Example: 4
• requestWaitTime(optional): integer
  Default Value: 1500

  Example: 1500
• responseWaitTime(optional): integer
  Default Value: 2

  Example: 2
• sendBufferSize(optional): integer
  Default Value: 200

  Example: 200
• skipBlockVerification(optional): boolean
  Default Value: false

  Example: false

{
    "type":"object",
    "properties":{
        "bootstrapPeers":{
            "type":"string"
        },
        "maxBlockCountToStore":{
            "type":"integer",
            "default":100,
            "example":100
        },
        "maxPropagationBurstLatency":{
            "type":"integer",
            "default":10,
            "example":10
        },
        "maxPropagationBurstSize":{
            "type":"integer",
            "default":10,
            "example":10
        },
        "propagateIterations":{
            "type":"integer",
            "default":1,
            "example":1
        },
        "maxConnectionAttempts":{
            "type":"integer",
            "default":120,
            "example":120
        },
        "msgExpirationFactor":{
            "type":"integer",
            "default":20,
            "example":20
        },
        "propagatePeerNumber":{
            "type":"integer",
            "default":3,
            "example":3
        },
        "pullInterval":{
            "type":"integer",
            "default":4,
            "example":4
        },
        "pullPeerNumber":{
            "type":"integer",
            "default":3,
            "example":3
        },
        "requestStateInfoInterval":{
            "type":"integer",
            "default":4,
            "example":4
        },
        "publishStateInfo":{
            "type":"integer",
            "default":4,
            "example":4
        },
        "publicCertPeriod":{
            "type":"integer",
            "default":10,
            "example":10
        },
        "dialTimeout":{
            "type":"integer",
            "default":3,
            "example":3
        },
        "connectTimeout":{
            "type":"integer",
            "default":2,
            "example":2
        },
        "receiveBufferSize":{
            "type":"integer",
            "default":20,
            "example":20
        },
        "sendBufferSize":{
            "type":"integer",
            "default":200,
            "example":200
        },
        "digestWaitTime":{
            "type":"integer",
            "default":1,
            "example":1
        },
        "requestWaitTime":{
            "type":"integer",
            "default":1500,
            "example":1500
        },
        "responseWaitTime":{
            "type":"integer",
            "default":2,
            "example":2
        },
        "aliveTimeInterval":{
            "type":"integer",
            "default":5,
            "example":5
        },
        "aliveExpirationTimeout":{
            "type":"integer",
            "default":25,
            "example":25
        },
        "reconnectInterval":{
            "type":"integer",
            "default":25,
            "example":25
        },
        "skipBlockVerification":{
            "type":"boolean",
            "default":false,
            "example":false
        }
    }
}

Nested Schema : gossipElection

Type: object

Show Source

• leader(optional): string
  Allowed Values: [ "UseLeaderElection", "OrgLeader" ]
• leaderALiveThreshold(optional): integer
  Default Value: 10

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

  Example: 5
• membershipSampleInterval(optional): integer
  Default Value: 1

  Example: 1

{
    "type":"object",
    "properties":{
        "membershipSampleInterval":{
            "type":"integer",
            "default":1,
            "example":1
        },
        "leaderALiveThreshold":{
            "type":"integer",
            "default":10,
            "example":10
        },
        "leaderElectionDuration":{
            "type":"integer",
            "default":5,
            "example":5
        },
        "leader":{
            "type":"string",
            "enum":[
                "UseLeaderElection",
                "OrgLeader"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Action result object

Body ()

Root Schema : peerPatchActionResult

Type: object

Show Source

• message(optional): string
• status(optional): string
  Allowed Values: [ "SUCCESS" ]

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "SUCCESS"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

400 Response

Invalid arguments

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

404 Response

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

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