REST API for Oracle Blockchain Platform Enterprise Edition

List Blockchain Platform Instances

get

/api/v1/blockchainPlatforms/instances

Get summary and list of Blockchain Platform instances.

Request

Supported Media Types

application/json

Query Parameters

includeSummary: string

Include instances summary: true or false

Allowed Values: [ true, false ]

Response

Supported Media Types

application/json

200 Response

Get summary and list of Blockchain Platform instances

Root Schema : schema

Type: array

Show Source

Array of: object BlockchainPlatformSummaryWrapper

Blockchain Platform summary list wrapper

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BlockchainPlatformSummaryWrapper"
    }
}

Nested Schema : BlockchainPlatformSummaryWrapper

Type: object

Blockchain Platform summary list wrapper

Show Source

instances: array instances

List of Blockchain Platform instances
summary: object InstancesCountSummary

Blockchain Platform instance count summary

{
    "description":"Blockchain Platform summary list wrapper",
    "type":"object",
    "properties":{
        "instances":{
            "description":"List of Blockchain Platform instances",
            "type":"array",
            "items":{
                "$ref":"#/definitions/BlockchainPlatformSummary"
            }
        },
        "summary":{
            "$ref":"#/definitions/InstancesCountSummary"
        }
    }
}

Nested Schema : instances

Type: array

List of Blockchain Platform instances

Show Source

Array of: object BlockchainPlatformSummary

Blockchain Platform summary

{
    "description":"List of Blockchain Platform instances",
    "type":"array",
    "items":{
        "$ref":"#/definitions/BlockchainPlatformSummary"
    }
}

Nested Schema : InstancesCountSummary

Type: object

Blockchain Platform instance count summary

Show Source

developerCount: integer

Total number of developer instances
enterpriseCount: integer

Total number of enterprise instances
founderCount: integer

Total number of founder instances
instancesCount: integer

Total number of instances
participantCount: integer

Total number of participant instances

{
    "description":"Blockchain Platform instance count summary",
    "type":"object",
    "properties":{
        "instancesCount":{
            "description":"Total number of instances",
            "type":"integer"
        },
        "founderCount":{
            "description":"Total number of founder instances",
            "type":"integer"
        },
        "participantCount":{
            "description":"Total number of participant instances",
            "type":"integer"
        },
        "enterpriseCount":{
            "description":"Total number of enterprise instances",
            "type":"integer"
        },
        "developerCount":{
            "description":"Total number of developer instances",
            "type":"integer"
        }
    }
}

Nested Schema : BlockchainPlatformSummary

Type: object

Blockchain Platform summary

Show Source

configuration: string

Allowed Values: [ "Developer", "Enterprise" ]

Type of compute configuration: Developer or Enterprise
createActivityId: string

The activity ID of the create operation that created the instance
createdBy: string

The user who created the instance
displayName: string

Instance display name, can be renamed
domainName: string

Instance domain name
id(required): string

Unique identifier that is immutable on creation
lifecycleState: string

Allowed Values: [ "Creating", "Active", "Updating", "Terminating", "Terminated", "Starting", "Stopping", "Stopped", "Patching", "RollBack", "ScalingOut", "ScalingIn", "Unknown", "Failed" ]

The current operation state of the instance
platformRole: string

Allowed Values: [ "Founder", "Participant" ]

Role of platform: Founder or Participant
serviceEndpoint: string

Instance data plane console endpoint
stateMessage: string

Instance state message
status: string

Allowed Values: [ "Healthy", "Unhealthy", "Down", "Unknown", "Stopped" ]

Instance status
statusDisplayName: string

Allowed Values: [ "Up", "PartiallyUp", "Down", "Unknown", "Stopped" ]

Instance status display name
timeCreated: string(date-time)

The time the the instance was created. An RFC3339 formatted datetime string
timeUpdated: string(date-time)

The time the instance was updated. An RFC3339 formatted datetime string
version: string

Instance version

{
    "description":"Blockchain Platform summary",
    "type":"object",
    "required":[
        "id"
    ],
    "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. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the instance was updated. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"The user who created the instance",
            "type":"string"
        },
        "createActivityId":{
            "description":"The activity 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"
            ]
        },
        "status":{
            "type":"string",
            "description":"Instance status",
            "enum":[
                "Healthy",
                "Unhealthy",
                "Down",
                "Unknown",
                "Stopped"
            ]
        },
        "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"
        },
        "version":{
            "description":"Instance version",
            "type":"string"
        },
        "domainName":{
            "description":"Instance domain name",
            "type":"string"
        },
        "stateMessage":{
            "description":"Instance state message",
            "type":"string"
        },
        "serviceEndpoint":{
            "description":"Instance data plane console endpoint",
            "type":"string"
        },
        "statusDisplayName":{
            "type":"string",
            "description":"Instance status display name",
            "enum":[
                "Up",
                "PartiallyUp",
                "Down",
                "Unknown",
                "Stopped"
            ]
        }
    }
}

400 Response

Bad request

401 Response

Not authorized

404 Response

Invalid parameters

429 Response

Too many requests

Root Schema : Error

Type: object

Error information.

Show Source

errors: array errors

List of errors
message(required): string

A human-readable error string.
status(required): string

A short error status that defines the error, meant for programmatic parsing.
warnings: 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

Service unavailable

Default Response

Unknown error

Root Schema : Error

Type: object

Error information.

Show Source

errors: array errors

List of errors
message(required): string

A human-readable error string.
status(required): string

A short error status that defines the error, meant for programmatic parsing.
warnings: 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"
    }
}

Examples

This endpoint is used to get the list and summary of the Blockchain Platform instances.

The following example shows how to query and get the summary and the list of Blockchain Platform instances 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-9cda2c311b55 \
  -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:

{
    "instances": [
        {
            "id": "93d26463-e4b9-4773-b1c1-9cda2c311b55",
            "displayName": "myNATinstf1",
            "timeCreated": 1566971517441,
            "timeUpdated": 1566972304422,
            "createdBy": "obpuser",
            "createOperationId": "IDR0yB4PWpqjaqTe__iq2c03PIe2H-QCypb3DGyCjCWJE=",
            "platformRole": "Founder",
            "configuration": "Developer",
            "status": "Healthy",
            "lifecycleState": "Active",
            "version": "19.3.2",
            "instanceFQDN": "",
            "enableTLS": true,
            "startPort": 0,
            "stateMessage": "",
            "statusDisplayName": "Up"
        }
    ],
    "summary": {
        "instancesCount": 1,
        "founderCount": 1,
        "participantCount": 0,
        "enterpriseCount": 0,
        "developerCount": 1
    }
}