Jump to

• Request
• Response

Get Blockchain Platform Information

get

/20191010/blockchainPlatforms/{blockchainPlatformId}

Gets information about a Blockchain Platform identified by the specific ID.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieves the service with the given ID

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

Type: object

Blockchain Platform Instance Description.

Show Source

• compartmentId: string
  Compartment identifier
• componentDetails(optional): object BlockchainPlatformComponentDetails
  Blockchain Platform component details.
• computeShape: string
  Allowed Values: [ "STANDARD", "ENTERPRISE_SMALL", "ENTERPRISE_MEDIUM", "ENTERPRISE_LARGE", "ENTERPRISE_EXTRA_LARGE", "ENTERPRISE_CUSTOM" ]

  Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, or ENTERPRISE_CUSTOM.
• definedTags(optional): 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(optional): string
  Platform instance description
• displayName: string
  Platform Instance Display name, can be renamed
• freeformTags(optional): 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"}`
• hostOcpuUtilizationInfo(optional): array hostOcpuUtilizationInfo
  List of OcpuUtilization for all hosts
• id: string
  Unique identifier that is immutable on creation
• isByol(optional): boolean
  Bring your own license
• isChaincodeClusterEnabled(optional): boolean
  Multiple chaincode hosts enabled in the platform cluster
• isMultiAD(optional): boolean
  True for multi-AD Blockchain Platforms, false for single-AD
• lifecycleDetails(optional): string
  A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
• lifecycleState(optional): string
  Allowed Values: [ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "SCALING", "INACTIVE", "FAILED" ]

  The current state of the Blockchain Platform.
• platformRole: string
  Allowed Values: [ "FOUNDER", "PARTICIPANT" ]

  Role of platform: FOUNDER or PARTICIPANT
• replicas(optional): object ReplicaDetails
  Number of replicas of service components like REST Proxy, CA and Console
• serviceEndpoint(optional): string
  Service endpoint URL, valid post-provisioning
• serviceVersion(optional): string
  The version of the Blockchain Platform.
• storageSizeInTBs(optional): number(double)
  Storage size in TBs
• storageUsedInTBs(optional): number(double)
  Storage used in TBs
• timeCreated(optional): string(date-time)
  The time the the Blockchain Platform was created. An RFC3339 formatted datetime string
• timeUpdated(optional): string(date-time)
  The time the Blockchain Platform was updated. An RFC3339 formatted datetime string
• totalOcpuCapacity(optional): integer
  Number of total OCPUs allocated to the platform cluster

{
    "description":"Blockchain Platform Instance Description.",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"blockchainplatform",
        "ocidEntityType":"blockchainplatform",
        "adLocality":"regional",
        "activeLifecycleStates":[
            "ACTIVE",
            "UPDATING",
            "INACTIVE",
            "SCALING",
            "FAILED"
        ],
        "deletedLifecycleStates":[
            "DELETED"
        ],
        "getOperationId":"GetBlockchainPlatform",
        "listResourcesOperationId":"ListBlockchainPlatforms"
    },
    "required":[
        "id",
        "compartmentId",
        "displayName",
        "platformRole",
        "computeShape"
    ],
    "properties":{
        "id":{
            "description":"Unique identifier that is immutable on creation",
            "type":"string"
        },
        "displayName":{
            "description":"Platform Instance Display name, can be renamed",
            "type":"string"
        },
        "compartmentId":{
            "description":"Compartment identifier",
            "type":"string"
        },
        "description":{
            "description":"Platform instance description",
            "type":"string"
        },
        "isByol":{
            "description":"Bring your own license",
            "type":"boolean"
        },
        "timeCreated":{
            "description":"The time the the Blockchain Platform was created. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the Blockchain Platform was updated. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "serviceVersion":{
            "description":"The version of the Blockchain Platform.",
            "type":"string"
        },
        "platformRole":{
            "description":"Role of platform: FOUNDER or PARTICIPANT",
            "enum":[
                "FOUNDER",
                "PARTICIPANT"
            ],
            "type":"string"
        },
        "computeShape":{
            "description":"Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, or ENTERPRISE_CUSTOM.",
            "enum":[
                "STANDARD",
                "ENTERPRISE_SMALL",
                "ENTERPRISE_MEDIUM",
                "ENTERPRISE_LARGE",
                "ENTERPRISE_EXTRA_LARGE",
                "ENTERPRISE_CUSTOM"
            ],
            "type":"string"
        },
        "serviceEndpoint":{
            "description":"Service endpoint URL, valid post-provisioning",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the Blockchain Platform.",
            "enum":[
                "CREATING",
                "UPDATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "SCALING",
                "INACTIVE",
                "FAILED"
            ],
            "type":"string"
        },
        "lifecycleDetails":{
            "description":"A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.",
            "type":"string"
        },
        "storageSizeInTBs":{
            "type":"number",
            "format":"double",
            "description":"Storage size in TBs"
        },
        "storageUsedInTBs":{
            "type":"number",
            "format":"double",
            "description":"Storage used in TBs"
        },
        "isMultiAD":{
            "type":"boolean",
            "description":"True for multi-AD Blockchain Platforms, false for single-AD"
        },
        "totalOcpuCapacity":{
            "type":"integer",
            "description":"Number of total OCPUs allocated to the platform cluster"
        },
        "isChaincodeClusterEnabled":{
            "type":"boolean",
            "description":"Multiple chaincode hosts enabled in the platform cluster"
        },
        "componentDetails":{
            "$ref":"#/definitions/BlockchainPlatformComponentDetails"
        },
        "replicas":{
            "$ref":"#/definitions/ReplicaDetails"
        },
        "hostOcpuUtilizationInfo":{
            "type":"array",
            "description":"List of OcpuUtilization for all hosts",
            "items":{
                "$ref":"#/definitions/OcpuUtilizationInfo"
            }
        },
        "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 : 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 : 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 : hostOcpuUtilizationInfo

Type: array

List of OcpuUtilization for all hosts

Show Source

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

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

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

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

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