REST API for Oracle Blockchain Platform Enterprise Edition

Scale Out a Blockchain Platform Instance

post

/api/v1/blockchainPlatforms/instances/{id}/scaleout

Scale out a Blockchain Platform instance.

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Unique platform instance identifier

Request payload in JSON

Root Schema : ScaleOutPayload

Type: object

Scale out payload

Show Source

newOrderer(required): object ScaleOutOrdererDetails

Orderer details to be added
newPeer(required): object ScaleOutPeerDetails

Peer details to be added
newReplicas(required): object ScaleOutReplicaNumberDetails

One node (service) number to be added

{
    "type":"object",
    "description":"Scale out payload",
    "properties":{
        "newReplicas":{
            "$ref":"#/definitions/ScaleOutReplicaNumberDetails"
        },
        "newPeer":{
            "$ref":"#/definitions/ScaleOutPeerDetails"
        },
        "newOrderer":{
            "$ref":"#/definitions/ScaleOutOrdererDetails"
        }
    },
    "required":[
        "newReplicas",
        "newPeer",
        "newOrderer"
    ],
    "x-or":[
        "newReplicas",
        "newPeer",
        "newOrderer"
    ]
}

Nested Schema : ScaleOutOrdererDetails

Type: object

Orderer details to be added

Show Source

logLevel: string

Allowed Values: [ "PANIC", "ERROR", "WARNING", "INFO", "NOTICE", "DEBUG" ]

Peer log level
org: string

Organization name

{
    "type":"object",
    "description":"Orderer details to be added",
    "properties":{
        "org":{
            "type":"string",
            "description":"Organization name"
        },
        "logLevel":{
            "type":"string",
            "description":"Peer log level",
            "enum":[
                "PANIC",
                "ERROR",
                "WARNING",
                "INFO",
                "NOTICE",
                "DEBUG"
            ]
        }
    }
}

Nested Schema : ScaleOutPeerDetails

Type: object

Peer details to be added

Show Source

alias: string

Peer alias
logLevel: string

Allowed Values: [ "PANIC", "ERROR", "WARNING", "INFO", "NOTICE", "DEBUG" ]

Peer log level
org: string

Organization name
role: string

Allowed Values: [ "Member", "Admin" ]

Peer role

{
    "type":"object",
    "description":"Peer details to be added",
    "properties":{
        "org":{
            "type":"string",
            "description":"Organization name"
        },
        "role":{
            "type":"string",
            "description":"Peer role",
            "enum":[
                "Member",
                "Admin"
            ]
        },
        "logLevel":{
            "type":"string",
            "description":"Peer log level",
            "enum":[
                "PANIC",
                "ERROR",
                "WARNING",
                "INFO",
                "NOTICE",
                "DEBUG"
            ]
        },
        "alias":{
            "type":"string",
            "description":"Peer alias"
        }
    }
}

Nested Schema : ScaleOutReplicaNumberDetails

Type: object

One node (service) number to be added

Show Source

CA(required): integer

CA replicas number to add
proxy(required): integer

REST proxy replicas number to add

{
    "type":"object",
    "description":"One node (service) number to be  added",
    "properties":{
        "proxy":{
            "type":"integer",
            "description":"REST proxy replicas number to add"
        },
        "CA":{
            "type":"integer",
            "description":"CA replicas number to add"
        }
    },
    "required":[
        "proxy",
        "CA"
    ],
    "x-or":[
        "proxy",
        "CA"
    ]
}

Response

Supported Media Types

application/json

202 Response

Accepted

Headers

Location: string

Location header with a URL to query the status of the request.

401 Response

Not authorized

404 Response

Invalid parameters

409 Response

Operation conflict

Root Schema : Error

Type: object

Error information.

Show Source

errors: array errors

List of errors
message(required): string

A human-readable error string.
status(required): string

A short error status that defines the error, meant for programmatic parsing.
warnings: array warnings

List of warnings

{
    "description":"Error information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"List of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"List of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors

Show Source

Array of: string

{
    "type":"array",
    "description":"List of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

List of warnings

Show Source

Array of: string

{
    "type":"array",
    "description":"List of warnings",
    "items":{
        "type":"string"
    }
}

500 Response

Service unavailable

Examples

This endpoint is used to scale out a particular Blockchain platform instance.

You can scale out an instance using any of the following methods:

Create New VMs: adds a new VM to the cluster; platform host, chaincode host, or Zookeeper/Kafka host.
Create New Replicas: adds additional nodes; REST proxy or CA.
Create New Peers: adds one additional peer at a time.

The following example shows how to query and scale out a particular Blockchain Platform instance by submitting a POST request on the REST resource using cURL:

curl -X POST \
  http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/e1f7bcfe-cc7e-4d19-97fb-772b231fcf99/scaleout \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \
  -H 'Content-Type: application/json'

Example of the Request Body

The following example shows the contents of the request body in JSON format:

{
 "newPeers": [
   {
     "org": "currentinstance",
     "role": "Member",
     "logLevel": "PANIC",
     "alias": "abcd",
     "vm": "myvm.oracle.com"
   }
 ]
}

Example of the Response Body

The following example shows the contents of the response body:

202 Accepted