Oracle Blockchain Platform Enterprise Edition REST API

Blockchain Platformインスタンスの詳細の取得

get

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

特定のBlockchain Platformインスタンスの詳細を取得します。

リクエスト

サポートされるメディア・タイプ

application/json

パス・パラメータ

id: string

プラットフォーム・インスタンスの一意の識別子

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json

200レスポンス

ルート・スキーマ: BlockchainPlatformDetails

型: object

Blockchain Platformの詳細

ソースの表示

cluster(オプション): object BlockchainPlatformCluster

クラスタ内のVM
components(オプション): array components

すべてのノード(サービス)の情報
configuration(オプション): string

許容値: [ "Developer", "Enterprise" ]

コンピュート構成のタイプ: DeveloperまたはEnterprise
createdBy(オプション): string

インスタンスを作成したユーザー
createOperationId(オプション): string

インスタンスを作成した作成操作の操作ID
displayName(オプション): string

インスタンスの表示名。名前を変更できます
enableTLS(オプション): boolean

デフォルトのロード・バランサでTLSを有効化するか無効化するかを決定します。
id(オプション): string

作成時に変更できない一意の識別子
instanceFQDN(オプション): string

外部ロード・バランサが使用されていることを示すインスタンスFQDN
lastOpid(オプション): string

インスタンスの最後の操作のID
ledgerPlacement(オプション): array ledgerPlacement

(ホスト - 台帳の場所)ペアのリスト
lifecycleState(オプション): string

許容値: [ "Creating", "Active", "Updating", "Terminating", "Terminated", "Starting", "Stopping", "Stopped", "Patching", "RollBack", "ScalingOut", "ScalingIn", "Unknown", "Failed" ]

インスタンスの現在の操作の状態
logging(オプション): string

VMのロギング・パス
platformRole(オプション): string

許容値: [ "Founder", "Participant" ]

プラットフォームのロール: FounderまたはParticipant
serviceEndpoint(オプション): string

サービス・エンドポイントURL、プロビジョニング後有効
startPort(オプション): integer

外部ロード・バランサ開始ポート
stateMessage(オプション): string

現在の状態を詳細に説明するメッセージ。たとえば、障害が発生した状態のリソースに関する有用な情報を提供するために使用できます。
status(オプション): string

許容値: [ "Healthy", "Unhealthy", "Down", "Unknown", "Stopped" ]

インスタンスのステータス
statusDisplayName(オプション): string

許容値: [ "Up", "PartiallyUp", "Down", "Unknown", "Stopped" ]

インスタンス・ステータス表示名
timeCreated(オプション): string(date-time)

インスタンスが作成された時間。タイムスタンプ文字列。
timeUpdated(オプション): string(date-time)

インスタンスが更新された時間。タイムスタンプ文字列。
version(オプション): string

インスタンスのバージョン

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

ネストしたスキーマ: BlockchainPlatformCluster

型: object

クラスタ内のVM

ソースの表示

crc(オプション): array crc

CRC VMのリスト
manager(オプション): array manager

マネージャVMのリスト
zk(オプション): array zk

ZooKeeperまたはKafka VMのリスト

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

ネストしたスキーマ: components

型: array

すべてのノード(サービス)の情報

ソースの表示

配列: object BlockchainPlatformComponent

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

ネストしたスキーマ: ledgerPlacement

型: array

(ホスト - 台帳の場所)ペアのリスト

ソースの表示

配列: object HostLedgerInfo

使用可能なその他のプロパティ: additionalProperties

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

ネストしたスキーマ: crc

型: array

CRC VMのリスト

ソースの表示

配列: object ClusterVM

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

ネストしたスキーマ: manager

型: array

マネージャVMのリスト

ソースの表示

配列: object ClusterVM

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

ネストしたスキーマ: zk

型: array

ZooKeeperまたはKafka VMのリスト

ソースの表示

配列: object ClusterVM

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

ネストしたスキーマ: ClusterVM

型: object

ソースの表示

role(オプション): string

許容値: [ "admin", "worker" ]

swarmクラスタでのVMのロール
vm(オプション): string

VMのホスト名またはIP
vmStatus(オプション): string

許容値: [ "up", "down" ]

VMのステータス: upまたは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"
            ]
        }
    }
}

ネストしたスキーマ: BlockchainPlatformComponent

型: object

ソースの表示

host(オプション): array host

すべてのノード(サービス)レプリカ・ホスト。レプリカが停止している場合、レプリカ数よりも少ない場合があります
name(オプション): string

ノード(サービス)名
replicas(オプション): integer

ノード(サービス)レプリカ数
status(オプション): string

許容値: [ "healthy", "unhealthy", "down" ]

ノード(サービス)のステータス: すべてのレプリカで稼働している場合はhealthy、停止しているレプリカがある場合はunhealthy、すべてのレプリカが停止している場合はdown
type(オプション): string

許容値: [ "ca", "console", "peer", "orderer", "proxy", "zookeeper", "kafka", "ldap", "prometheus", "lbr", "nodemanager", "authserver", "restproxy" ]

ノード(サービス)のタイプ

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

ネストしたスキーマ: host

型: array

すべてのノード(サービス)レプリカ・ホスト。レプリカが停止している場合、レプリカ数よりも少ない場合があります

ソースの表示

配列: string

VMのホスト名または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"
    }
}

ネストしたスキーマ: HostLedgerInfo

型: object

使用可能なその他のプロパティ

ソースの表示

string

他の動的に生成されたオーダラおよびピアの名前のキーと台帳のフォルダ・パス

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

ソースの表示

host(オプション): string

ホスト名
sharedDirectory(オプション): string

ホスト上の台帳フォルダのパス

{
    "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レスポンス

未認可

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

errors(オプション): array errors

エラーのリスト
message: string

判読可能なエラー文字列。
status: string

プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
warnings(オプション): array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

配列: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

配列: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

404レスポンス

見つかりません

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

errors(オプション): array errors

エラーのリスト
message: string

判読可能なエラー文字列。
status: string

プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
warnings(オプション): array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

配列: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

配列: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500レスポンス

内部サーバー・エラー

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

errors(オプション): array errors

エラーのリスト
message: string

判読可能なエラー文字列。
status: string

プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
warnings(オプション): array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

配列: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

配列: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

先頭に戻る

例

このエンドポイントは、特定のBlockchain Platformインスタンスの詳細を取得するために使用されます。

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行し、特定のBlockchain Platformインスタンスの詳細を問い合せて取得する方法を示します。

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

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

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

先頭に戻る