Jump to

• Request
• Response

Get Peer List

get

/console/admin/api/v1.1/nodes/peers

Get a list of peers on a channel. If no parameter is specified, all peers will be returned. If specified by channelName, the peers which have joined the channel will be returned. If specified by chaincode, the peers which have installed the chaincode will be returned.

Request

Supported Media Types

• application/json

Query Parameters

• chaincode(optional): string
  Chaincode name
• channelName(optional): string
  Channel name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response with peers listed

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object peer2

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/peer2"
    }
}

Nested Schema : peer2

Type: object

Show Source

• displayName(optional): string
• eventUrl(optional): string
• mspId(optional): string
• peerId: string
• status(optional): string
  Allowed Values: [ "up", "down" ]
• url(optional): string

{
    "type":"object",
    "required":[
        "peerId"
    ],
    "properties":{
        "peerId":{
            "type":"string"
        },
        "mspId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "up",
                "down"
            ]
        },
        "url":{
            "type":"string"
        },
        "eventUrl":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

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

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