Jump to

• Request
• Response
• Examples

Get Blockchain Platform Instance Details

get

/api/v1/blockchainPlatforms/instances/{id}

Get a particular Blockchain Platform instance details.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Unique platform instance identifier

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : BlockchainPlatformDetails

Type: object

Blockchain Platform details

Show Source

• cluster(optional): object BlockchainPlatformCluster
  VMs in cluster
• components(optional): array components
  All nodes(services) info
• configuration(optional): string
  Allowed Values: [ "Developer", "Enterprise" ]

  Type of compute configuration: Developer or Enterprise
• createdBy(optional): string
  The user who created the instance
• createOperationId(optional): string
  The operation ID of the create operation that created the instance
• displayName(optional): string
  Instance display name, can be renamed
• enableTLS(optional): boolean
  Determines whether to enable or disable TLS with the default load balancer.
• id(optional): string
  Unique identifier that is immutable on creation
• instanceFQDN(optional): string
  Instance FQDN indicating external load balancer is used
• lastOpid(optional): string
  Last operation ID on the instance
• ledgerPlacement(optional): array ledgerPlacement
  List of (host - ledger location) pairs
• lifecycleState(optional): string
  Allowed Values: [ "Creating", "Active", "Updating", "Terminating", "Terminated", "Starting", "Stopping", "Stopped", "Patching", "RollBack", "ScalingOut", "ScalingIn", "Unknown", "Failed" ]

  The current operation state of the instance
• logging(optional): string
  Logging path on VM
• platformRole(optional): string
  Allowed Values: [ "Founder", "Participant" ]

  Role of platform: Founder or Participant
• serviceEndpoint(optional): string
  Service endpoint URL, valid post-provisioning
• startPort(optional): integer
  External load balancer start port
• stateMessage(optional): string
  An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
• status(optional): string
  Allowed Values: [ "Healthy", "Unhealthy", "Down", "Unknown", "Stopped" ]

  Instance status
• statusDisplayName(optional): string
  Allowed Values: [ "Up", "PartiallyUp", "Down", "Unknown", "Stopped" ]

  instance status display name
• timeCreated(optional): string(date-time)
  The time the the instance was created. A timestamp string.
• timeUpdated(optional): string(date-time)
  The time the Instance was updated. A timestamp string.
• version(optional): string
  Instance Version

{
    "description":"Blockchain Platform details",
    "type":"object",
    "properties":{
        "id":{
            "description":"Unique identifier that is immutable on creation",
            "type":"string"
        },
        "displayName":{
            "description":"Instance display name, can be renamed",
            "type":"string"
        },
        "timeCreated":{
            "description":"The time the the instance was created. A timestamp string.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the Instance was updated. A timestamp string.",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"The user who created the instance",
            "type":"string"
        },
        "createOperationId":{
            "description":"The operation ID of the create operation that created the instance",
            "type":"string"
        },
        "platformRole":{
            "description":"Role of platform: Founder or Participant",
            "type":"string",
            "enum":[
                "Founder",
                "Participant"
            ]
        },
        "configuration":{
            "description":"Type of compute configuration: Developer or Enterprise",
            "type":"string",
            "enum":[
                "Developer",
                "Enterprise"
            ]
        },
        "version":{
            "description":"Instance Version",
            "type":"string"
        },
        "enableTLS":{
            "type":"boolean",
            "description":"Determines whether to enable or disable TLS with the default load balancer."
        },
        "startPort":{
            "description":"External load balancer start port",
            "type":"integer"
        },
        "instanceFQDN":{
            "description":"Instance FQDN indicating external load balancer is used",
            "type":"string"
        },
        "logging":{
            "type":"string",
            "description":"Logging path on VM"
        },
        "lastOpid":{
            "type":"string",
            "description":"Last operation ID on the instance"
        },
        "serviceEndpoint":{
            "description":"Service endpoint URL, valid post-provisioning",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current operation state of the instance",
            "enum":[
                "Creating",
                "Active",
                "Updating",
                "Terminating",
                "Terminated",
                "Starting",
                "Stopping",
                "Stopped",
                "Patching",
                "RollBack",
                "ScalingOut",
                "ScalingIn",
                "Unknown",
                "Failed"
            ],
            "type":"string"
        },
        "stateMessage":{
            "description":"An 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"
        },
        "status":{
            "type":"string",
            "description":"Instance status",
            "enum":[
                "Healthy",
                "Unhealthy",
                "Down",
                "Unknown",
                "Stopped"
            ]
        },
        "statusDisplayName":{
            "type":"string",
            "description":"instance status display name",
            "enum":[
                "Up",
                "PartiallyUp",
                "Down",
                "Unknown",
                "Stopped"
            ]
        },
        "cluster":{
            "$ref":"#/definitions/BlockchainPlatformCluster"
        },
        "components":{
            "type":"array",
            "description":"All nodes(services) info",
            "items":{
                "$ref":"#/definitions/BlockchainPlatformComponent"
            }
        },
        "ledgerPlacement":{
            "type":"array",
            "description":"List of (host - ledger location) pairs",
            "items":{
                "$ref":"#/definitions/HostLedgerInfo"
            }
        }
    }
}

Nested Schema : BlockchainPlatformCluster

Type: object

VMs in cluster

Show Source

• crc(optional): array crc
  CRC VM list
• manager(optional): array manager
  Manager VM list
• zk(optional): array zk
  ZooKeeper or Kafka VM list

{
    "type":"object",
    "description":"VMs in cluster",
    "properties":{
        "manager":{
            "type":"array",
            "description":"Manager VM list",
            "items":{
                "$ref":"#/definitions/ClusterVM"
            }
        },
        "crc":{
            "type":"array",
            "description":"CRC VM list",
            "items":{
                "$ref":"#/definitions/ClusterVM"
            }
        },
        "zk":{
            "type":"array",
            "description":"ZooKeeper or Kafka VM list",
            "items":{
                "$ref":"#/definitions/ClusterVM"
            }
        }
    }
}

Nested Schema : components

Type: array

All nodes(services) info

Show Source

• Array of: object BlockchainPlatformComponent

{
    "type":"array",
    "description":"All nodes(services) info",
    "items":{
        "$ref":"#/definitions/BlockchainPlatformComponent"
    }
}

Nested Schema : ledgerPlacement

Type: array

List of (host - ledger location) pairs

Show Source

• Array of: object HostLedgerInfo
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of (host - ledger location) pairs",
    "items":{
        "$ref":"#/definitions/HostLedgerInfo"
    }
}

Nested Schema : crc

Type: array

CRC VM list

Show Source

• Array of: object ClusterVM

{
    "type":"array",
    "description":"CRC VM list",
    "items":{
        "$ref":"#/definitions/ClusterVM"
    }
}

Nested Schema : manager

Type: array

Manager VM list

Show Source

• Array of: object ClusterVM

{
    "type":"array",
    "description":"Manager VM list",
    "items":{
        "$ref":"#/definitions/ClusterVM"
    }
}

Nested Schema : zk

Type: array

ZooKeeper or Kafka VM list

Show Source

• Array of: object ClusterVM

{
    "type":"array",
    "description":"ZooKeeper or Kafka VM list",
    "items":{
        "$ref":"#/definitions/ClusterVM"
    }
}

Nested Schema : ClusterVM

Type: object

Show Source

• role(optional): string
  Allowed Values: [ "admin", "worker" ]

  VM role in swarm cluster
• vm(optional): string
  VM host name or IP
• vmStatus(optional): string
  Allowed Values: [ "up", "down" ]

  VM status: up or down

{
    "type":"object",
    "properties":{
        "vm":{
            "type":"string",
            "description":"VM host name or IP"
        },
        "vmStatus":{
            "type":"string",
            "enum":[
                "up",
                "down"
            ],
            "description":"VM status: up or down"
        },
        "role":{
            "type":"string",
            "description":"VM role in swarm cluster",
            "enum":[
                "admin",
                "worker"
            ]
        }
    }
}

Nested Schema : BlockchainPlatformComponent

Type: object

Show Source

• host(optional): array host
  All node(service) replicas hosts, may be smaller than the replicas number when any replica is down
• name(optional): string
  Node(service) name
• replicas(optional): integer
  Node(service) replicas number
• status(optional): string
  Allowed Values: [ "healthy", "unhealthy", "down" ]

  Node(service) status: healthy for all replicas up, unhealthy for any replicas down, down for all replicas down
• type(optional): string
  Allowed Values: [ "ca", "console", "peer", "orderer", "proxy", "zookeeper", "kafka", "ldap", "prometheus", "lbr", "nodemanager", "authserver", "restproxy" ]

  Node(service) type

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Node(service) name"
        },
        "type":{
            "type":"string",
            "enum":[
                "ca",
                "console",
                "peer",
                "orderer",
                "proxy",
                "zookeeper",
                "kafka",
                "ldap",
                "prometheus",
                "lbr",
                "nodemanager",
                "authserver",
                "restproxy"
            ],
            "description":"Node(service) type"
        },
        "status":{
            "type":"string",
            "description":"Node(service) status: healthy for all replicas up, unhealthy for any replicas down, down for all replicas down",
            "enum":[
                "healthy",
                "unhealthy",
                "down"
            ]
        },
        "replicas":{
            "type":"integer",
            "description":"Node(service) replicas number"
        },
        "host":{
            "type":"array",
            "description":"All node(service) replicas hosts, may be smaller than the replicas number when any replica is down",
            "items":{
                "type":"string",
                "description":"VM host name or IP"
            }
        }
    }
}

Nested Schema : host

Type: array

All node(service) replicas hosts, may be smaller than the replicas number when any replica is down

Show Source

• Array of: string
  VM host name or IP

{
    "type":"array",
    "description":"All node(service) replicas hosts, may be smaller than the replicas number when any replica is down",
    "items":{
        "type":"string",
        "description":"VM host name or IP"
    }
}

Nested Schema : HostLedgerInfo

Type: object

Additional Properties Allowed

Show Source

• string
  other dynamically generated orderer and peer name keys and ledger folder path

{
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Host name"
        },
        "sharedDirectory":{
            "type":"string",
            "description":"ledger folder path on the host"
        }
    },
    "additionalProperties":{
        "type":"string",
        "description":"other dynamically generated orderer and peer name keys and ledger folder path"
    }
}

Show Source

• host(optional): string
  Host name
• sharedDirectory(optional): string
  ledger folder path on the host

{
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Host name"
        },
        "sharedDirectory":{
            "type":"string",
            "description":"ledger folder path on the host"
        }
    },
    "additionalProperties":{
        "type":"string",
        "description":"other dynamically generated orderer and peer name keys and ledger folder path"
    }
}

401 Response

Unauthorized

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

404 Response

Not Found

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

Internal Server Error

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

Back to Top

Examples

This endpoint is used to get the details of a particular Blockchain Platform instance.

The following example shows how to query and get the details of a particular Blockchain Platform instance by submitting a GET request on the REST resource using cURL.

curl -X GET \
  http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/93d26463-e4b9-4773-b1c1-9cda2c311b44 \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \
  -H 'Content-Type: application/json'
  

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "id": "93d26463-e4b9-4773-b1c1-9cda2c311b44",
  "displayName": "myNATinstf1",
  "timeCreated": 1566971517441,
  "timeUpdated": 1566979960292,
  "createdBy": "obpuser",
  "createOperationId": "IDR0yB4PWpqjaqTe__iq2c03PIe2H-QCypb3DGyCjCXJE=",
  "platformRole": "Founder",
  "configuration": "Developer",
  "status": "Healthy",
  "lifecycleState": "Active",
  "version": "19.3.3",
  "instanceFQDN": "",
  "enableTLS": true,
  "startPort": 0,
  "stateMessage": "",
  "logging": "/u01/obp-logs",
  "serviceEndpoint": "https://myvm.oracle.com:10000",
  "cluster": {
    "manager": [
      {
        "vm": "myvm.oracle.com",
        "vmStatus": "Up",
        "role": "Admin"
      }
    ],
    "crc": null,
    "zk": null
  },
  "components": [
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-nodemanager",
      "type": "nodemanager",
      "status": "Healthy",
      "replicas": 3,
      "host": [
        "myvm.oracle.com",
        "myvm.oracle.com",
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-zookeeper1",
      "type": "zookeeper",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-zookeeper2",
      "type": "zookeeper",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-zookeeper3",
      "type": "zookeeper",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-kafka1",
      "type": "kafka",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-kafka2",
      "type": "kafka",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-kafka3",
      "type": "kafka",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-authserver",
      "type": "authserver",
      "status": "Healthy",
      "replicas": 3,
      "host": [
        "myvm.oracle.com",
        "myvm.oracle.com",
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-ca",
      "type": "ca",
      "status": "Healthy",
      "replicas": 2,
      "host": [
        "myvm.oracle.com",
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-orderer0",
      "type": "orderer",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-orderer1",
      "type": "orderer",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-peer0",
      "type": "peer",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-peer1",
      "type": "peer",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-console0",
      "type": "console",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-console1",
      "type": "console",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-restproxy",
      "type": "restproxy",
      "status": "Healthy",
      "replicas": 2,
      "host": [
        "myvm.oracle.com",
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-prometheus",
      "type": "prometheus",
      "status": "Healthy",
      "replicas": 1,
      "host": [
        "myvm.oracle.com"
      ]
    },
    {
      "name": "93d26463-e4b9-4773-b1c1-9cda2c311b44-lbr",
      "type": "lbr",
      "status": "Healthy",
      "replicas": 3,
      "host": [
        "myvm.oracle.com",
        "myvm.oracle.com",
        "myvm.oracle.com"
      ]
    }
  ],
  "ledgerPlacement": [
    {
      "93d26463-e4b9-4773-b1c1-9cda2c311b44-orderer0": "/u01/93d26463-e4b9-4773-b1c1-9cda2c311b44/orderer/93d26463-e4b9-4773-b1c1-9cda2c311b44-orderer0",
      "93d26463-e4b9-4773-b1c1-9cda2c311b44-orderer1": "/u01/93d26463-e4b9-4773-b1c1-9cda2c311b44/orderer/93d26463-e4b9-4773-b1c1-9cda2c311b44-orderer1",
      "93d26463-e4b9-4773-b1c1-9cda2c311b44-peer0": "/u01/93d26463-e4b9-4773-b1c1-9cda2c311b44/peer/93d26463-e4b9-4773-b1c1-9cda2c311b44-peer0",
      "93d26463-e4b9-4773-b1c1-9cda2c311b44-peer1": "/u01/93d26463-e4b9-4773-b1c1-9cda2c311b44/peer/93d26463-e4b9-4773-b1c1-9cda2c311b44-peer1",
      "host": "myvm.oracle.com",
      "sharedDirectory": "/u01/93d26463-e4b9-4773-b1c1-9cda2c311b44"
    }
  ],
  "statusDisplayName": "Up"
}

Back to Top