Show Source

• components: array components
  All services information
• configuration: string
  Allowed Values: [ "Developer", "Enterprise" ]

  Type of compute configuration: Developer or Enterprise
• createActivityId: string
  The operation 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: 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
  Service endpoint URL, valid post-provisioning
• stateMessage: 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: 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. A timestamp string.
• timeUpdated: string(date-time)
  The time the instance was updated. A timestamp string.
• version: 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"
        },
        "createActivityId":{
            "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"
        },
        "domainName":{
            "description":"Instance domain name",
            "type":"string"
        },
        "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"
            ]
        },
        "components":{
            "type":"array",
            "description":"All services information",
            "items":{
                "$ref":"#/definitions/BlockchainPlatformComponent"
            }
        }
    }
}

Show Source

• Array of: object BlockchainPlatformComponent

{
    "type":"array",
    "description":"All services information",
    "items":{
        "$ref":"#/definitions/BlockchainPlatformComponent"
    }
}

Show Source

• name: string
  Node (service) name
• replicas: integer
  Node (service) replicas number
• status: string
  Allowed Values: [ "Pending", "Provisioned", "Failed", "Terminated" ]

  Status of each service
• type: string
  Allowed Values: [ "ca", "console", "peer", "orderer", "hami", "prometheus", "authserver", "restproxy" ]

  Node (service) type

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Node (service) name"
        },
        "type":{
            "type":"string",
            "enum":[
                "ca",
                "console",
                "peer",
                "orderer",
                "hami",
                "prometheus",
                "authserver",
                "restproxy"
            ],
            "description":"Node (service) type"
        },
        "status":{
            "type":"string",
            "description":"Status of each service",
            "enum":[
                "Pending",
                "Provisioned",
                "Failed",
                "Terminated"
            ]
        },
        "replicas":{
            "type":"integer",
            "description":"Node (service) replicas number"
        }
    }
}