Jump to

• Request
• Response
• Examples

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: string
  Unique platform instance identifier

Body ()

request payload in JSON

Root Schema : ScaleOutPayload

Type: object

scaleOut payload

Show Source

• newPeers(optional): array newPeers
  New peers list
• newReplicas(optional): object ScaleOutReplicaNumberDetails
  One node(service) number to be added
• newVMs(optional): object ClusterCreationDetails
  VM to construct cluster

{
    "type":"object",
    "description":"scaleOut payload",
    "properties":{
        "newVMs":{
            "$ref":"#/definitions/ClusterCreationDetails"
        },
        "newReplicas":{
            "$ref":"#/definitions/ScaleOutReplicaNumberDetails"
        },
        "newPeers":{
            "type":"array",
            "description":"New peers list",
            "items":{
                "$ref":"#/definitions/ScaleOutPeerDetails"
            }
        }
    }
}

Nested Schema : newPeers

Type: array

New peers list

Show Source

• Array of: object ScaleOutPeerDetails
  One peer details to be added

{
    "type":"array",
    "description":"New peers list",
    "items":{
        "$ref":"#/definitions/ScaleOutPeerDetails"
    }
}

Nested Schema : ScaleOutReplicaNumberDetails

Type: object

One node(service) number to be added

Show Source

• CA(optional): integer
  CA replicas number to add
• proxy(optional): 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"
        }
    }
}

Nested Schema : ClusterCreationDetails

Type: object

VM to construct cluster

Show Source

• crcHosts(optional): array crcHosts
  CRC VM list, not in swarm
• platformHosts(optional): array platformHosts
  Manager VM list: hostname or IP. For VM with multiple IPs, this must be IP, and it must include the current called Component Manager
• zkHosts(optional): array zkHosts
  Kafka/ZooKeeper Service VM list, in swarm

{
    "type":"object",
    "description":"VM to construct cluster",
    "properties":{
        "platformHosts":{
            "type":"array",
            "description":"Manager VM list: hostname or IP. For VM with multiple IPs, this must be IP, and it must include the current called Component Manager",
            "items":{
                "type":"string"
            }
        },
        "crcHosts":{
            "type":"array",
            "description":"CRC VM list, not in swarm",
            "items":{
                "type":"string"
            }
        },
        "zkHosts":{
            "type":"array",
            "description":"Kafka/ZooKeeper Service VM list, in swarm",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ScaleOutPeerDetails

Type: object

One peer details to be added

Show Source

• alias(optional): string
  Peer alias
• logLevel(optional): string
  Allowed Values: [ "PANIC", "ERROR", "WARNING", "INFO", "NOTICE", "DEBUG" ]

  Peer log level
• org(optional): string
  Organization name
• role(optional): string
  Allowed Values: [ "Member", "Admin" ]

  Peer role
• vm(optional): string
  VM hostname to locate peer

{
    "type":"object",
    "description":"One 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"
        },
        "vm":{
            "type":"string",
            "description":"VM hostname to locate peer"
        }
    }
}

Nested Schema : crcHosts

Type: array

CRC VM list, not in swarm

Show Source

• Array of: string

{
    "type":"array",
    "description":"CRC VM list, not in swarm",
    "items":{
        "type":"string"
    }
}

Nested Schema : platformHosts

Type: array

Manager VM list: hostname or IP. For VM with multiple IPs, this must be IP, and it must include the current called Component Manager

Show Source

• Array of: string

{
    "type":"array",
    "description":"Manager VM list: hostname or IP. For VM with multiple IPs, this must be IP, and it must include the current called Component Manager",
    "items":{
        "type":"string"
    }
}

Nested Schema : zkHosts

Type: array

Kafka/ZooKeeper Service VM list, in swarm

Show Source

• Array of: string

{
    "type":"array",
    "description":"Kafka/ZooKeeper Service VM list, in swarm",
    "items":{
        "type":"string"
    }
}

Back to Top

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

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors(optional): array errors
  list of errors
• message: string
  A human-readable error string.
• status: string
  A short error status that defines the error, meant for programmatic parsing.
• warnings(optional): 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

Back to Top

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

Back to Top