Jump to

• Request
• Response

Preview Scale Blockchain Platform

post

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

Internal use only. Preview the scaleout of the Blockchain Platform.

Request

Supported Media Types

• application/json

Path Parameters

• blockchainPlatformId: string
  Unique service identifier.

Header Parameters

• opc-request-id: string
  The client request ID for tracing.

Body ()

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(optional): array addOsns
  New OSNs to add
• addPeers(optional): array addPeers
  New peers to add
• addReplicas(optional): object ReplicaDetails
  Number of replicas of service components like REST Proxy, CA and Console
• addStorage(optional): object ScaleStorageDetails
  Storage size to increase
• modifyPeers(optional): array modifyPeers
  Modify OCPU allocation to existing peers
• removeOsns(optional): array removeOsns
  OSN ID list to remove
• removePeers(optional): array removePeers
  Peer ID list to remove
• removeReplicas(optional): 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(optional): integer
  Minimum Value: 1

  Maximum Value: 10

  Number of CA replicas
• consoleCount(optional): integer
  Minimum Value: 1

  Maximum Value: 10

  Number of console replicas
• proxyCount(optional): 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: 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: 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(optional): 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: 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: 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(optional): string
  Minimum Length: 1

  Maximum Length: 16

  peer alias
• ocpuAllocationParam: object OcpuAllocationNumberParam
  OCPU allocation parameter
• role: 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: object OcpuAllocationNumberParam
  OCPU allocation parameter
• peerName: 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Provides a preview of a scale operation

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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.

Body ()

Root Schema : ScaledBlockchainPlatformPreview

Type: object

Blockchain Platform Instance description preview after scaling.

Show Source

• compartmentId: string
  Compartment identifier
• componentDetails(optional): object BlockchainPlatformComponentDetails
  Blockchain Platform component details.
• componentDetailsPostScaling(optional): object BlockchainPlatformComponentDetails
  Blockchain Platform component details.
• computeShape: string
  Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, or ENTERPRISE_CUSTOM
• description(optional): string
  Blockchain Platform instance description
• displayName: string
  Blockchain Platform instance display name. Can be renamed.
• hostOcpuUtilizationInfo(optional): array hostOcpuUtilizationInfo
  List of OCPU utilization for all hosts
• hostOcpuUtilizationInfoPostScaling(optional): array hostOcpuUtilizationInfoPostScaling
  List of OCPU utilization for all hosts post-scaling
• id: string
  Unique identifier that is immutable on creation
• meteringPreview(optional): object ScaledPlatformMeteringPreview
  Blockchain Platform metering preview after scaling
• newVmCount(optional): integer
  Number of new VMs that would be created
• replicas(optional): object ReplicaDetails
  Number of replicas of service components like REST Proxy, CA and Console
• replicasPostScaling(optional): object ReplicaDetails
  Number of replicas of service components like REST Proxy, CA and Console
• scalePayload(optional): object ScaleBlockchainPlatformDetails
  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.
• storageSizeInTBs(optional): number(double)
  Storage size in TBs
• storageSizeInTBsPostScaling(optional): number(double)
  Storage size in TBs post-scaling

{
    "description":"Blockchain Platform Instance description preview after scaling.",
    "type":"object",
    "required":[
        "id",
        "compartmentId",
        "displayName",
        "computeShape"
    ],
    "properties":{
        "id":{
            "description":"Unique identifier that is immutable on creation",
            "type":"string"
        },
        "displayName":{
            "description":"Blockchain Platform instance display name. Can be renamed.",
            "type":"string"
        },
        "compartmentId":{
            "description":"Compartment identifier",
            "type":"string"
        },
        "description":{
            "description":"Blockchain Platform instance description",
            "type":"string"
        },
        "computeShape":{
            "description":"Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, or ENTERPRISE_CUSTOM",
            "type":"string"
        },
        "storageSizeInTBs":{
            "type":"number",
            "format":"double",
            "description":"Storage size in TBs"
        },
        "storageSizeInTBsPostScaling":{
            "type":"number",
            "format":"double",
            "description":"Storage size in TBs post-scaling"
        },
        "componentDetails":{
            "$ref":"#/definitions/BlockchainPlatformComponentDetails"
        },
        "replicas":{
            "$ref":"#/definitions/ReplicaDetails"
        },
        "componentDetailsPostScaling":{
            "$ref":"#/definitions/BlockchainPlatformComponentDetails"
        },
        "replicasPostScaling":{
            "$ref":"#/definitions/ReplicaDetails"
        },
        "hostOcpuUtilizationInfo":{
            "type":"array",
            "description":"List of OCPU utilization for all hosts",
            "items":{
                "$ref":"#/definitions/OcpuUtilizationInfo"
            }
        },
        "hostOcpuUtilizationInfoPostScaling":{
            "type":"array",
            "description":"List of OCPU utilization for all hosts post-scaling",
            "items":{
                "$ref":"#/definitions/OcpuUtilizationInfo"
            }
        },
        "newVmCount":{
            "type":"integer",
            "description":"Number of new VMs that would be created"
        },
        "meteringPreview":{
            "$ref":"#/definitions/ScaledPlatformMeteringPreview"
        },
        "scalePayload":{
            "$ref":"#/definitions/ScaleBlockchainPlatformDetails"
        }
    }
}

Nested Schema : BlockchainPlatformComponentDetails

Type: object

Blockchain Platform component details.

Show Source

• osns(optional): array osns
  List of OSNs
• peers(optional): array peers
  List of Peers

{
    "description":"Blockchain Platform component details.",
    "type":"object",
    "properties":{
        "osns":{
            "type":"array",
            "description":"List of OSNs",
            "items":{
                "$ref":"#/definitions/Osn"
            }
        },
        "peers":{
            "type":"array",
            "description":"List of Peers",
            "items":{
                "$ref":"#/definitions/Peer"
            }
        }
    }
}

Nested Schema : hostOcpuUtilizationInfo

Type: array

List of OCPU utilization for all hosts

Show Source

• Array of: object OcpuUtilizationInfo
  OCPU utilization for a VM host

{
    "type":"array",
    "description":"List of OCPU utilization for all hosts",
    "items":{
        "$ref":"#/definitions/OcpuUtilizationInfo"
    }
}

Nested Schema : hostOcpuUtilizationInfoPostScaling

Type: array

List of OCPU utilization for all hosts post-scaling

Show Source

• Array of: object OcpuUtilizationInfo
  OCPU utilization for a VM host

{
    "type":"array",
    "description":"List of OCPU utilization for all hosts post-scaling",
    "items":{
        "$ref":"#/definitions/OcpuUtilizationInfo"
    }
}

Nested Schema : ScaledPlatformMeteringPreview

Type: object

Blockchain Platform metering preview after scaling

Show Source

• extraStorageMeteredUnits(optional): number(double)
  Extra Storage units required in TBs
• storageMeteredUnits(optional): number(double)
  Current Storage metered units in TBs
• storageMeteredUnitsPostScaling(optional): number(double)
  Total Post Scaling Storage metered units in TBs
• totalOcpuAllocation(optional): number(float)
  Number of total OCPU allocation for the Blockchain Platform
• totalOcpuAllocationPostScaling(optional): number(float)
  Number of total OCPU allocation for the Blockchain Platform after scaling

{
    "description":"Blockchain Platform metering preview after scaling",
    "type":"object",
    "properties":{
        "totalOcpuAllocation":{
            "type":"number",
            "format":"float",
            "description":"Number of total OCPU allocation for the Blockchain Platform"
        },
        "totalOcpuAllocationPostScaling":{
            "type":"number",
            "format":"float",
            "description":"Number of total OCPU allocation for the Blockchain Platform after scaling"
        },
        "storageMeteredUnits":{
            "type":"number",
            "format":"double",
            "description":"Current Storage metered units in TBs"
        },
        "extraStorageMeteredUnits":{
            "type":"number",
            "format":"double",
            "description":"Extra Storage units required in TBs"
        },
        "storageMeteredUnitsPostScaling":{
            "type":"number",
            "format":"double",
            "description":"Total Post Scaling Storage metered units in TBs"
        }
    }
}

Nested Schema : ReplicaDetails

Type: object

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

Show Source

• caCount(optional): integer
  Minimum Value: 1

  Maximum Value: 10

  Number of CA replicas
• consoleCount(optional): integer
  Minimum Value: 1

  Maximum Value: 10

  Number of console replicas
• proxyCount(optional): 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 : 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(optional): array addOsns
  New OSNs to add
• addPeers(optional): array addPeers
  New peers to add
• addReplicas(optional): object ReplicaDetails
  Number of replicas of service components like REST Proxy, CA and Console
• addStorage(optional): object ScaleStorageDetails
  Storage size to increase
• modifyPeers(optional): array modifyPeers
  Modify OCPU allocation to existing peers
• removeOsns(optional): array removeOsns
  OSN ID list to remove
• removePeers(optional): array removePeers
  Peer ID list to remove
• removeReplicas(optional): 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 : osns

Type: array

List of OSNs

Show Source

• Array of: object Osn
  Ordering Service Node details

{
    "type":"array",
    "description":"List of OSNs",
    "items":{
        "$ref":"#/definitions/Osn"
    }
}

Nested Schema : peers

Type: array

List of Peers

Show Source

• Array of: object Peer
  Peer details

{
    "type":"array",
    "description":"List of Peers",
    "items":{
        "$ref":"#/definitions/Peer"
    }
}

Nested Schema : Osn

Type: object

Ordering Service Node details

Show Source

• ad: string

  Availability domain for the 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 is mapped to one of the three fault domains available in each availability domain.

• lifecycleState(optional): string
  Allowed Values: [ "ACTIVE", "INACTIVE", "FAILED" ]

  The current state of the OSN.
• ocpuAllocationParam(optional): object OcpuAllocationNumberParam
  OCPU allocation parameter
• osnKey: string
  Minimum Length: 1

  Maximum Length: 255

  OSN identifier

{
    "type":"object",
    "description":"Ordering Service Node details",
    "required":[
        "osnKey",
        "ad"
    ],
    "properties":{
        "osnKey":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "description":"OSN identifier"
        },
        "ad":{
            "description":"<p>Availability domain for the 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 is 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"
        },
        "lifecycleState":{
            "description":"The current state of the OSN.",
            "enum":[
                "ACTIVE",
                "INACTIVE",
                "FAILED"
            ],
            "type":"string"
        }
    }
}

Nested Schema : OcpuAllocationNumberParam

Type: object

OCPU allocation parameter

Show Source

• ocpuAllocationNumber: 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 : Peer

Type: object

Peer details

Show Source

• ad: string

  Availability domain of the 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 of the peer is mapped to one of the three fault domains available in each availability domain.

• alias(optional): string
  peer alias
• host: string
  Host on which the peer exists
• lifecycleState(optional): string
  Allowed Values: [ "ACTIVE", "INACTIVE", "FAILED" ]

  The current state of the peer.
• ocpuAllocationParam(optional): object OcpuAllocationNumberParam
  OCPU allocation parameter
• peerKey: string
  Minimum Length: 1

  Maximum Length: 255

  peer identifier
• role: string
  Peer role

{
    "type":"object",
    "description":"Peer details",
    "required":[
        "peerKey",
        "role",
        "host",
        "ad"
    ],
    "properties":{
        "peerKey":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "description":"peer identifier"
        },
        "role":{
            "description":"Peer role",
            "x-obmcs-enumref":"#/definitions/PeerRole/role",
            "type":"string"
        },
        "alias":{
            "type":"string",
            "description":"peer alias"
        },
        "ocpuAllocationParam":{
            "$ref":"#/definitions/OcpuAllocationNumberParam"
        },
        "host":{
            "type":"string",
            "description":"Host on which the peer exists"
        },
        "ad":{
            "description":"<p>Availability domain of the 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 of the peer is mapped to one of the three fault domains available in each availability domain.</p>",
            "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the peer.",
            "enum":[
                "ACTIVE",
                "INACTIVE",
                "FAILED"
            ],
            "type":"string"
        }
    }
}

Nested Schema : OcpuUtilizationInfo

Type: object

OCPU utilization for a VM host

Show Source

• host(optional): string
  Host name of VM
• ocpuCapacityNumber(optional): number(float)
  Number of total OCPU capacity on the host
• ocpuUtilizationNumber(optional): number(float)
  Number of OCPUs utilized

{
    "type":"object",
    "description":"OCPU utilization for a VM host",
    "properties":{
        "host":{
            "type":"string",
            "description":"Host name of VM"
        },
        "ocpuUtilizationNumber":{
            "type":"number",
            "format":"float",
            "description":"Number of OCPUs utilized"
        },
        "ocpuCapacityNumber":{
            "type":"number",
            "format":"float",
            "description":"Number of total OCPU capacity on the host"
        }
    }
}

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 : ScaleStorageDetails

Type: object

Storage size to increase

Show Source

• storageSizeInTBs: 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: 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(optional): 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 : CreatePeerDetails

Type: object

The peer details to be added

Show Source

• ad: 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(optional): string
  Minimum Length: 1

  Maximum Length: 16

  peer alias
• ocpuAllocationParam: object OcpuAllocationNumberParam
  OCPU allocation parameter
• role: 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: object OcpuAllocationNumberParam
  OCPU allocation parameter
• peerName: 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"
        }
    }
}

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.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: 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.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: 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"
        }
    }
}

Back to Top