REST API for Oracle Blockchain Platform on Oracle Cloud Infrastructure (Hyperledger Fabric v2.5)

List Blockchain Platform Peers

get

/20191010/blockchainPlatforms/{blockchainPlatformId}/peers

Lists all Blockchain Platform peers.

Request

Supported Media Types

application/json

Path Parameters

blockchainPlatformId(required): string

Unique service identifier.

Query Parameters

displayName: string

Minimum Length: 1

Maximum Length: 255

A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`
limit: integer

Minimum Value: 1

Maximum Value: 1000

The maximum number of items to return.

Default Value: 10
page: string

Minimum Length: 1

Maximum Length: 2048

The page at which to start retrieving results.
sortBy: string

The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

Default Value: timeCreated

Allowed Values: [ "timeCreated", "displayName" ]
sortOrder: string

The sort order to use, either 'ASC' for ascending or 'DESC' for decending.

Default Value: ASC

Allowed Values: [ "ASC", "DESC" ]

Header Parameters

opc-request-id: string

The client request ID for tracing.
opc-retry-token: string

Minimum Length: 1

Maximum Length: 64

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Response

Supported Media Types

application/json

200 Response

Gets list of Blockchain Platform peers

Headers

opc-next-page: string

For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : PeerCollection

Type: object

Result of a peer list or search. Contains PeerSummary

Show Source

items(required): array items

Collection of PeerSummary

{
    "type":"object",
    "description":"Result of a peer list or search. Contains PeerSummary",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Collection of PeerSummary",
            "items":{
                "$ref":"#/definitions/PeerSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Collection of PeerSummary

Show Source

Array of: object PeerSummary

Peer summary information for returning in a list.

{
    "type":"array",
    "description":"Collection of PeerSummary",
    "items":{
        "$ref":"#/definitions/PeerSummary"
    }
}

Nested Schema : PeerSummary

Type: object

Peer summary information for returning in a list.

Show Source

lifecycleState: string

The current state of the peer.
peerKey: string

Minimum Length: 1

Maximum Length: 255

Peer identifier

{
    "type":"object",
    "description":"Peer summary information for returning in a list.",
    "properties":{
        "peerKey":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "description":"Peer identifier"
        },
        "lifecycleState":{
            "description":"The current state of the peer.",
            "x-obmcs-enumref":"#/definitions/Peer/lifecycleState",
            "type":"string"
        }
    }
}

400 Response

Bad Request

401 Response

Not authorized

404 Response

Invalid parameters

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

500 Response

Service unavailable

Default Response

Unknown Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}