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

Update Blockchain Platform

put

/20191010/blockchainPlatforms/{blockchainPlatformId}

Updates a particular 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.

The Blockchain Platform fields to update. Fields that are not provided will not be updated.

Root Schema : UpdateBlockchainPlatformDetails

Type: object

Blockchain Platform details for updating a service.

Show Source

definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
description: string

Platform Description
freeformTags: object freeformTags

Additional Properties Allowed: additionalProperties

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
loadBalancerShape: string

Type of Load Balancer shape: LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS.
replicas: object ReplicaDetails

Number of replicas of service components like REST Proxy, CA and Console
storageSizeInTBs: number(double)

Storage size in TBs
totalOcpuCapacity: integer

Number of total OCPUs to allocate

{
    "description":"Blockchain Platform details for updating a service.",
    "type":"object",
    "properties":{
        "description":{
            "description":"Platform Description",
            "type":"string"
        },
        "storageSizeInTBs":{
            "type":"number",
            "format":"double",
            "description":"Storage size in TBs"
        },
        "replicas":{
            "$ref":"#/definitions/ReplicaDetails"
        },
        "totalOcpuCapacity":{
            "type":"integer",
            "description":"Number of total OCPUs to allocate"
        },
        "loadBalancerShape":{
            "description":"Type of Load Balancer shape: LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/BlockchainPlatform/loadBalancerShape"
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
                }
            }
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

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

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer and boolean types are supported.

Response

Supported Media Types

application/json

202 Response

The update request 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"
        }
    }
}

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.

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