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

Scale Blockchain Platform

post

/20191010/blockchainPlatforms/{blockchainPlatformId}/actions/scale

Internal use only. Scale the Blockchain Platform.

Request

Supported Media Types

application/json

Path Parameters

blockchainPlatformId(required): string

Unique service identifier.

Header Parameters

if-match: string

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
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.

Input payload to scaleout Blockchain Platform. The payload cannot be empty.

Root Schema : ScaleBlockchainPlatformDetails

Type: object

Scale operation details for a Blockchain Platform. The scale operation payload has multiple options:

Add one or more ordering service nodes (addOsns)
Add one or more peers (addPeers)
Add more replicas of CA, console and REST proxy nodes (addReplicas)
Add more storage to the platform (addStorage)
Modify the CPU allocation for peer nodes (modifyPeers)
Remove one or more replicas of CA, console and REST Proxy nodes (removeReplicas)
Remove one or more ordering service nodes (removeOsns)
Remove one or more peers (removePeers)

The scale operation payload must have at least one of the above options.

Show Source

addOsns: array addOsns

New OSNs to add
addPeers: array addPeers

New peers to add
addReplicas: object ReplicaDetails

Number of replicas of service components like REST Proxy, CA and Console
addStorage: object ScaleStorageDetails

Storage size to increase
modifyPeers: array modifyPeers

Modify OCPU allocation to existing peers
removeOsns: array removeOsns

OSN ID list to remove
removePeers: array removePeers

Peer ID list to remove
removeReplicas: object ReplicaDetails

Number of replicas of service components like REST Proxy, CA and Console

{
    "description":"Scale operation details for a Blockchain Platform. The scale operation payload has multiple options:\n <ul><li>Add one or more ordering service nodes (addOsns)</li> <li>Add one or more peers (addPeers)</li> <li>Add more replicas of CA, console and REST proxy nodes (addReplicas)</li> <li>Add more storage to the platform (addStorage)</li> <li>Modify the CPU allocation for peer nodes (modifyPeers)</li> <li>Remove one or more replicas of CA, console and REST Proxy nodes (removeReplicas)</li> <li>Remove one or more ordering service nodes (removeOsns)</li> <li>Remove one or more peers (removePeers)</li></ul>\nThe scale operation payload must have at least one of the above options.\n",
    "type":"object",
    "properties":{
        "addOsns":{
            "type":"array",
            "description":"New OSNs to add",
            "items":{
                "$ref":"#/definitions/CreateOsnDetails"
            }
        },
        "addReplicas":{
            "$ref":"#/definitions/ReplicaDetails"
        },
        "addPeers":{
            "type":"array",
            "description":"New peers to add",
            "items":{
                "$ref":"#/definitions/CreatePeerDetails"
            }
        },
        "addStorage":{
            "$ref":"#/definitions/ScaleStorageDetails"
        },
        "modifyPeers":{
            "type":"array",
            "description":"Modify OCPU allocation to existing peers",
            "items":{
                "$ref":"#/definitions/ModifyPeerDetails"
            }
        },
        "removeReplicas":{
            "$ref":"#/definitions/ReplicaDetails"
        },
        "removeOsns":{
            "type":"array",
            "description":"OSN ID list to remove",
            "items":{
                "type":"string"
            }
        },
        "removePeers":{
            "type":"array",
            "description":"Peer ID list to remove",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : addOsns

Type: array

New OSNs to add

Show Source

Array of: object CreateOsnDetails

The ordering service node details to be added

{
    "type":"array",
    "description":"New OSNs to add",
    "items":{
        "$ref":"#/definitions/CreateOsnDetails"
    }
}

Nested Schema : addPeers

Type: array

New peers to add

Show Source

Array of: object CreatePeerDetails

The peer details to be added

{
    "type":"array",
    "description":"New peers to add",
    "items":{
        "$ref":"#/definitions/CreatePeerDetails"
    }
}

Nested Schema : ReplicaDetails

Type: object

Number of replicas of service components like REST Proxy, CA and Console

Show Source

caCount: integer

Minimum Value: 1

Maximum Value: 10

Number of CA replicas
consoleCount: integer

Minimum Value: 1

Maximum Value: 10

Number of console replicas
proxyCount: integer

Minimum Value: 1

Maximum Value: 10

Number of REST proxy replicas

{
    "type":"object",
    "description":"Number of replicas of service components like REST Proxy, CA and Console",
    "properties":{
        "proxyCount":{
            "type":"integer",
            "minimum":"1",
            "maximum":"10",
            "description":"Number of REST proxy replicas"
        },
        "caCount":{
            "type":"integer",
            "minimum":"1",
            "maximum":"10",
            "description":"Number of CA replicas"
        },
        "consoleCount":{
            "type":"integer",
            "minimum":"1",
            "maximum":"10",
            "description":"Number of console replicas"
        }
    }
}

Nested Schema : ScaleStorageDetails

Type: object

Storage size to increase

Show Source

storageSizeInTBs(required): integer

Minimum Value: 1

Maximum Value: 96

Storage size in TBs

{
    "type":"object",
    "description":"Storage size to increase",
    "required":[
        "storageSizeInTBs"
    ],
    "properties":{
        "storageSizeInTBs":{
            "type":"integer",
            "minimum":"1",
            "maximum":"96",
            "description":"Storage size in TBs"
        }
    }
}

Nested Schema : modifyPeers

Type: array

Modify OCPU allocation to existing peers

Show Source

Array of: object ModifyPeerDetails

Peer to modify OCPU allocation

{
    "type":"array",
    "description":"Modify OCPU allocation to existing peers",
    "items":{
        "$ref":"#/definitions/ModifyPeerDetails"
    }
}

Nested Schema : removeOsns

Type: array

OSN ID list to remove

Show Source

Array of: string

{
    "type":"array",
    "description":"OSN ID list to remove",
    "items":{
        "type":"string"
    }
}

Nested Schema : removePeers

Type: array

Peer ID list to remove

Show Source

Array of: string

{
    "type":"array",
    "description":"Peer ID list to remove",
    "items":{
        "type":"string"
    }
}

Nested Schema : CreateOsnDetails

Type: object

The ordering service node details to be added

Show Source

ad(required): string

Availability domain for the new OSN. Options are AD1/AD2/AD3.
For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number that you select will be mapped to one of the three fault domains available in each availability domain.
ocpuAllocationParam: object OcpuAllocationNumberParam

OCPU allocation parameter

{
    "type":"object",
    "description":"The ordering service node details to be added",
    "required":[
        "ad"
    ],
    "properties":{
        "ad":{
            "description":"<p>Availability domain for the new OSN. Options are AD1/AD2/AD3.</p><p>For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number that you select will be mapped to one of the three fault domains available in each availability domain.</p>",
            "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads",
            "type":"string"
        },
        "ocpuAllocationParam":{
            "$ref":"#/definitions/OcpuAllocationNumberParam"
        }
    }
}

Nested Schema : OcpuAllocationNumberParam

Type: object

OCPU allocation parameter

Show Source

ocpuAllocationNumber(required): number(float)

Minimum Value: 0

Maximum Value: 64

Number of OCPU allocation

{
    "type":"object",
    "description":"OCPU allocation parameter",
    "required":[
        "ocpuAllocationNumber"
    ],
    "properties":{
        "ocpuAllocationNumber":{
            "type":"number",
            "format":"float",
            "minimum":"0",
            "maximum":"64",
            "description":"Number of OCPU allocation"
        }
    }
}

Nested Schema : CreatePeerDetails

Type: object

The peer details to be added

Show Source

ad(required): string

Availability domain to place new peer. Options are AD1/AD2/AD3.
For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number that you select will be mapped to one of the three fault domains available in each availability domain.
alias: string

Minimum Length: 1

Maximum Length: 16

peer alias
ocpuAllocationParam(required): object OcpuAllocationNumberParam

OCPU allocation parameter
role(required): string

Peer role

{
    "type":"object",
    "description":"The peer details to be added",
    "required":[
        "role",
        "ocpuAllocationParam",
        "ad"
    ],
    "properties":{
        "role":{
            "description":"Peer role",
            "x-obmcs-enumref":"#/definitions/PeerRole/role",
            "type":"string"
        },
        "alias":{
            "type":"string",
            "minLength":"1",
            "maxLength":"16",
            "description":"peer alias"
        },
        "ocpuAllocationParam":{
            "$ref":"#/definitions/OcpuAllocationNumberParam"
        },
        "ad":{
            "description":"<p>Availability domain to place new peer. Options are AD1/AD2/AD3.</p><p>For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number that you select will be mapped to one of the three fault domains available in each availability domain.</p>",
            "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads",
            "type":"string"
        }
    }
}

Nested Schema : ModifyPeerDetails

Type: object

Peer to modify OCPU allocation

Show Source

ocpuAllocationParam(required): object OcpuAllocationNumberParam

OCPU allocation parameter
peerName(required): string

Minimum Length: 1

Maximum Length: 64

Peer identifier

{
    "type":"object",
    "description":"Peer to modify OCPU allocation",
    "required":[
        "peerName",
        "ocpuAllocationParam"
    ],
    "properties":{
        "peerName":{
            "type":"string",
            "minLength":"1",
            "maxLength":"64",
            "description":"Peer identifier"
        },
        "ocpuAllocationParam":{
            "$ref":"#/definitions/OcpuAllocationNumberParam"
        }
    }
}

Response

Supported Media Types

application/json

202 Response

The request to scaleout was accepted.

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.
opc-work-request-id: string

Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

400 Response

Bad Request

401 Response

Not authorized

404 Response

Invalid parameters

409 Response

Conflict

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"
        }
    }
}

412 Response

Precondition failed

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"
        }
    }
}