Jump to

• Request
• Response
• Examples

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 ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Get summary and list of blockchain platform instances

Body ()

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(optional): array instances
  List of Blockchain Platform instances
• summary(optional): object InstancesCountSummary
  Blockchain Platform 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 Summary

Show Source

• developerCount(optional): integer
  Total number of developer instances
• enterpriseCount(optional): integer
  Total number of enterprise instances
• founderCount(optional): integer
  Total number of founder instances
• instancesCount(optional): integer
  Total number of instances
• participantCount(optional): integer
  Total number of participant instances

{
    "description":"Blockchain Platform 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(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: string
  Unique identifier that is immutable on creation
• instanceFQDN(optional): string
  Instance FQDN indicating external load balancer is used
• 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
• platformRole(optional): string
  Allowed Values: [ "Founder", "Participant" ]

  Role of platform: Founder or Participant
• startPort(optional): integer
  External load balancer start port
• 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. An RFC3339 formatted datetime string
• timeUpdated(optional): string(date-time)
  The time the instance was updated. An RFC3339 formatted datetime string
• version(optional): 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"
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
        },
        "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"
        }
    }
}

400 Response

Bad Request

401 Response

Not authorized

404 Response

Invalid parameters

429 Response

Too Many Requests

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

Service unavailable

Default Response

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

Back to Top