REST API for Oracle Blockchain Platform Enterprise Edition

Get Orderer Information

get

/console/admin/api/v2/nodes/orderers/{ordererId}/exportOSN

Retrieves an orderer node's information.

Request

Supported Media Types

application/json

Path Parameters

ordererId(required): string

ID of the orderer being queried

Response

Supported Media Types

application/json

200 Response

Response with the OSN information object

Root Schema : exportOSNInfo

Type: object

Show Source

mspId: string
orderingServiceNodes: array orderingServiceNodes
signature: string

{
    "type":"object",
    "properties":{
        "mspId":{
            "type":"string"
        },
        "orderingServiceNodes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "ordererId":{
                        "type":"string"
                    },
                    "displayName":{
                        "type":"string"
                    },
                    "address":{
                        "type":"string"
                    },
                    "raftAddress":{
                        "type":"string"
                    },
                    "adminAddress":{
                        "type":"string"
                    },
                    "server_tls_cert":{
                        "type":"string"
                    },
                    "client_tls_cert":{
                        "type":"string"
                    }
                }
            }
        },
        "signature":{
            "type":"string"
        }
    }
}

Nested Schema : orderingServiceNodes

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ordererId":{
                "type":"string"
            },
            "displayName":{
                "type":"string"
            },
            "address":{
                "type":"string"
            },
            "raftAddress":{
                "type":"string"
            },
            "adminAddress":{
                "type":"string"
            },
            "server_tls_cert":{
                "type":"string"
            },
            "client_tls_cert":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

address: string
adminAddress: string
client_tls_cert: string
displayName: string
ordererId: string
raftAddress: string
server_tls_cert: string

{
    "type":"object",
    "properties":{
        "ordererId":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "address":{
            "type":"string"
        },
        "raftAddress":{
            "type":"string"
        },
        "adminAddress":{
            "type":"string"
        },
        "server_tls_cert":{
            "type":"string"
        },
        "client_tls_cert":{
            "type":"string"
        }
    }
}

400 Response

Invalid arguments

Root Schema : 400errorModels

Type: object

Show Source

key: string
value: 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

Root Schema : 500errorModels

Type: object

Show Source

key: string
value: string

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

Default Response

Unexpected error

Root Schema : errorModel

Type: object

Show Source

code(required): integer(int32)
message(required): string

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