Blockchain Platformインスタンスの詳細の取得
get
/api/v1/blockchainPlatforms/instances/{id}
特定のBlockchain Platformインスタンスの詳細を取得します。
リクエスト
サポートされるメディア・タイプ
- application/json
パス・パラメータ
- id(必須): string
プラットフォーム・インスタンスの一意の識別子
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: BlockchainPlatformDetails
型:
object
Blockchain Platformの詳細
ソースの表示
- components: array components
すべてのサービス情報
- configuration: string
許容値:
[ "Developer", "Enterprise" ]
コンピュート構成のタイプ: DeveloperまたはEnterprise - createActivityId: string
インスタンスを作成した作成操作の操作ID
- createdBy: string
インスタンスを作成したユーザー
- displayName: string
インスタンスの表示名。名前を変更できます
- domainName: string
インスタンス・ドメイン名
- id: string
作成時に変更できない一意の識別子
- lifecycleState: string
許容値:
[ "Creating", "Active", "Updating", "Terminating", "Terminated", "Starting", "Stopping", "Stopped", "Patching", "RollBack", "ScalingOut", "ScalingIn", "Unknown", "Failed" ]
インスタンスの現在の操作の状態 - platformRole: string
許容値:
[ "Founder", "Participant" ]
プラットフォームのロール: FounderまたはParticipant - serviceEndpoint: string
サービス・エンドポイントURL、プロビジョニング後有効
- 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
インスタンスのバージョン
ネストしたスキーマ: BlockchainPlatformComponent
型:
ソースの表示
object
- name: string
ノード(サービス)名
- replicas: integer
ノード(サービス)レプリカ数
- status: string
許容値:
[ "Pending", "Provisioned", "Failed", "Terminated" ]
各サービスのステータス - type: string
許容値:
[ "ca", "console", "peer", "orderer", "hami", "prometheus", "authserver", "restproxy" ]
ノード(サービス)のタイプ
401レスポンス
未認可
404レスポンス
無効なパラメータ
500レスポンス
サービス使用不可
例
このエンドポイントは、特定の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" }