Oracle Blockchain Platform Enterprise Edition REST API

すべてのRESTエンドポイント

アプリケーション操作

管理操作用のREST API

RESTプロキシAPIのバージョンの取得: メソッド: get
パス: /restproxy/api/version

アプリケーション操作/イベント

次の操作を使用してチェーンコード・イベントのサブスクライブまたはサブスクライブ解除を行います。

イベント・サブスクリプションのリスト: メソッド: get
パス: /restproxy/api/v2/channels/{channelId}/event-subscriptions
イベントのサブスクライブ: メソッド: post
パス: /restproxy/api/v2/channels/{channelId}/event-subscriptions
イベントからのサブスクライブ解除: メソッド: delete
パス: /restproxy/api/v2/channels/{channelId}/event-subscriptions

アプリケーション操作/トランザクション

次の操作を使用してチェーンコード・トランザクションの問合せおよび呼出しを行います。

新規トランザクションIDおよびnonceの取得: メソッド: get
パス: /restproxy/api/v2/channels/{channelId}/transaction-id
トランザクション情報の取得: メソッド: get
パス: /restproxy/api/v2/channels/{channelId}/transactions/{transactionId}
チェーンコードの問合せ: メソッド: post
パス: /restproxy/api/v2/channels/{channelId}/chaincode-queries
トランザクションの送信: メソッド: post
パス: /restproxy/api/v2/channels/{channelId}/transactions

ブロックチェーン・ネットワーク管理操作/チェーンコード

チェーンコードの操作用のREST API

チェーンコード情報の取得: メソッド: get
パス: /console/admin/api/v1.1/chaincodes/{chaincodeName}
インストールされているチェーンコードのリストの取得: メソッド: get
パス: /console/admin/api/v1.1/chaincodes
チェーンコードのインストール: メソッド: post
パス: /console/admin/api/v1.1/chaincodes
チェーンコードのインスタンス化: メソッド: post
パス: /console/admin/api/v1.1/chaincodes/{chaincodeName}/instantiate

ブロックチェーン・ネットワーク管理操作/チャネル

チャネルの操作用のREST API

チャネルに組織を追加します: メソッド: post
パス: /console/admin/api/v1.1/channels/{channelName}/organizations
チャネルへのOSNの追加: メソッド: post
パス: /console/admin/api/v1.1/channels/{channelName}/orderers/joinOSN
システム・チャネルへのOSNの追加: メソッド: post
パス: /console/admin/api/v1.1/channels/syschannel/addOSN
チャネルの作成: メソッド: post
パス: /console/admin/api/v1.1/channels
ブロックのデータのリストの取得: メソッド: get
パス: /console/admin/api/v1.1/channels/{channelName}/blocks
チャネル・ブロック・データの取得: メソッド: get
パス: /console/admin/api/v1.1/channels/{channelName}/blocks/{blockId}
チャネル情報の取得: メソッド: get
パス: /console/admin/api/v1.1/channels/{channelName}
チャネル・リストの取得: メソッド: get
パス: /console/admin/api/v1.1/channels
チャネルのオーダラの拡張属性の取得: メソッド: get
パス: /console/admin/api/v1.1/channels/{channelName}/orderingSettings
システム・チャネルの構成ブロックの取得: メソッド: get
パス: /console/admin/api/v1.1/channels/syschannel/configblock
チャネルから組織を削除します: メソッド: delete
パス: /console/admin/api/v1.1/channels/{channelName}/organizations/{mspId}
チャネルからのOSNの削除: メソッド: post
パス: /console/admin/api/v1.1/channels/{channelName}/orderers/removeOSN
チャネルのアンカー・ピアの設定: メソッド: post
パス: /console/admin/api/v1.1/channels/{channelName}/organizations/{mspId}/anchorPeers
チャネル構成の更新(v19.1.3で非推奨): メソッド: patch
パス: /console/admin/api/v1.1/channels/{channelName}
チャネルのオーダラの拡張属性の更新: メソッド: patch
パス: /console/admin/api/v1.1/channels/{channelName}/orderingSettings
チャネルのポリシーの更新: メソッド: post
パス: /console/admin/api/v1.1/channels/{channelName}/policies

ブロックチェーン・ネットワーク管理操作/ノード

ノードの操作用のREST API

ノードのエクスポート(21.1.2で非推奨): メソッド: get
パス: /console/admin/api/v1.1/nodes/export
CAノードの構成の取得: メソッド: get
パス: /console/admin/api/v1.1/nodes/fabricCAs/{caId}/
ノード・リストの取得: メソッド: get
パス: /console/admin/api/v1.1/nodes
オーダラ情報の取得: メソッド: get
パス: /console/admin/api/v1.1/nodes/orderers/{ordererId}/exportOSN
オーダラ・ノードの構成の取得: メソッド: get
パス: /console/admin/api/v1.1/nodes/orderers/{ordererId}
ピアの属性の取得: メソッド: get
パス: /console/admin/api/v1.1/nodes/peers/{peerId}
ピア・リストの取得: メソッド: get
パス: /console/admin/api/v1.1/nodes/peers
RESTプロキシ・ノードの構成の取得: メソッド: get
パス: /console/admin/api/v1.1/nodes/restproxies/{restProxyId}
オーダラへの構成ブロックのインポート: メソッド: post
パス: /console/admin/api/v1.1/nodes/orderers/{ordererId}/importNCB
ノードのインポート(21.1.2で非推奨): メソッド: post
パス: /console/admin/api/v1.1/nodes/import
チャネルへのピアの参加: メソッド: post
パス: /console/admin/api/v1.1/nodes/peers/{peerId}/joinChannel
CAノードの起動: メソッド: post
パス: /console/admin/api/v1.1/nodes/fabricCAs/{caId}/start
ピア・ノードの起動: メソッド: post
パス: /console/admin/api/v1.1/nodes/peers/{peerId}/start
RESTプロキシ・ノードの起動: メソッド: post
パス: /console/admin/api/v1.1/nodes/restproxies/{restProxyId}/start
オーダラ・ノードの起動: メソッド: post
パス: /console/admin/api/v1.1/nodes/orderers/{ordererId}/start
CAノードの停止: メソッド: post
パス: /console/admin/api/v1.1/nodes/fabricCAs/{caId}/stop
ピアの停止: メソッド: post
パス: /console/admin/api/v1.1/nodes/peers/{peerId}/stop
RESTプロキシ・ノードの停止: メソッド: post
パス: /console/admin/api/v1.1/nodes/restproxies/{restProxyId}/stop
オーダラ・ノードの停止: メソッド: post
パス: /console/admin/api/v1.1/nodes/orderers/{ordererId}/stop
CAノードの構成の更新: メソッド: patch
パス: /console/admin/api/v1.1/nodes/fabricCAs/{caId}/
オーダラ・ノードの構成の更新: メソッド: patch
パス: /console/admin/api/v1.1/nodes/orderers/{ordererId}
ピア・ノードの構成の更新: メソッド: patch
パス: /console/admin/api/v1.1/nodes/peers/{peerId}
RESTプロキシ・ノードの構成の更新: メソッド: patch
パス: /console/admin/api/v1.1/nodes/restproxies/{restProxyId}
ブロックの検証: メソッド: get
パス: /console/admin/api/v1.1/nodes/peers/{peerId}/blockaudit/{channelName}

ブロックチェーン・ネットワーク管理操作/組織

組織の操作用のREST API

ネットワークへの組織の追加: メソッド: post
パス: /console/admin/api/v1.1/organizations/{orgName}/joinNewOrgs
接続プロファイルのダウンロード: メソッド: get
パス: /console/admin/api/v1.1/organizations/{orgName}/connectionProfile/{zip}
すべての組織の取得: メソッド: get
パス: /console/admin/api/v1.1/organizations
オーダラ・サービスの設定の取得: メソッド: get
パス: /console/admin/api/v1.1/organizations/{orgName}/orderingService
組織の管理者資格証明の取得: メソッド: get
パス: /console/admin/api/v1.1/organizations/{orgName}/adminCredentials
組織の証明書の取得: メソッド: get
パス: /console/admin/api/v1.1/organizations/{orgName}/certificates
組織のオーダラ・サービスの設定: メソッド: post
パス: /console/admin/api/v1.1/organizations/{orgName}/setOrderingService

Blockchain Platform管理操作/構成

次の操作を使用して、プラットフォーム構成を操作します。

LDAP構成の作成: メソッド: post
パス: /api/v1/configuration/ldapConfig
コントロール・プレーン構成の作成または更新: メソッド: post
パス: /api/v1/configuration/cpConfig/list
コントロール・プレーン構成の削除: メソッド: delete
パス: /api/v1/configuration/cpConfig/{configName}
LDAP構成の削除: メソッド: delete
パス: /api/v1/configuration/ldapConfig/{id}
コントロール・プレーンのすべての構成の取得: メソッド: get
パス: /api/v1/configuration/cpConfig
コントロール・プレーン構成の取得: メソッド: get
パス: /api/v1/configuration/cpConfig/{configName}
LDAP構成の取得: メソッド: get
パス: /api/v1/configuration/ldapConfig/{id}
リリースのビルド情報の取得: メソッド: get
パス: /api/v1/configuration/release/buildInfo
LDAP構成のリスト: メソッド: get
パス: /api/v1/configuration/ldapConfig
コントロール・プレーン構成の保存または更新: メソッド: post
パス: /api/v1/configuration/cpConfig
LDAP構成のテスト: メソッド: post
パス: /api/v1/configuration/ldapConfig/test
LDAP構成の更新: メソッド: post
パス: /api/v1/configuration/ldapConfig/{id}

Blockchain Platform管理操作/プラットフォーム

次の操作を使用してOracle Blockchain Platformを管理します。

ターゲット・インスタンスへのパッチの適用: メソッド: post
パス: /api/v1/blockchainPlatforms/patches/{patchId}/apply
新規Blockchain Platformインスタンスの作成: メソッド: post
パス: /api/v1/blockchainPlatforms/instances
Blockchain Platformインスタンスの削除: メソッド: delete
パス: /api/v1/blockchainPlatforms/instances/{id}
すべてのアクティビティ詳細の取得: メソッド: get
パス: /api/v1/blockchainPlatforms/activities
Blockchain Platformインスタンスの詳細の取得: メソッド: get
パス: /api/v1/blockchainPlatforms/instances/{id}
Blockchain Platformのステータスの取得: メソッド: get
パス: /api/v1/blockchainPlatforms/instances/{id}/status
外部ロード・バランサ・ポート・マッピングの取得: メソッド: get
パス: /api/v1/blockchainPlatforms/instances/{id}/lbrportmapping
インスタンス・アクティビティ詳細の取得: メソッド: get
パス: /api/v1/blockchainPlatforms/instances/{id}/activity
インスタンスのパッチの詳細の取得: メソッド: get
パス: /api/v1/blockchainPlatforms/instances/{id}/patch
インスタンス作成用のロード・バランサ・ポートのマッピングの取得: メソッド: get
パス: /api/v1/blockchainPlatforms/instances/generateLBRPortMapping
スケール・アウト用のロード・バランサ・ポートのマッピングの取得: メソッド: get
パス: /api/v1/blockchainPlatforms/instances/{id}/Scaleout/generateLBRPortMapping
インスタンスの操作ステータスの取得: メソッド: get
パス: /api/v1/blockchainPlatforms/instances/{id}/operation/{opid}/status
Blockchain Platformインスタンスのリスト: メソッド: get
パス: /api/v1/blockchainPlatforms/instances
Blockchain Platformパッチ・ターゲットのリスト: メソッド: get
パス: /api/v1/blockchainPlatforms/patches/{patchId}/targets
Blockchain Platformのパッチのリスト: メソッド: get
パス: /api/v1/blockchainPlatforms/patches
Blockchain Platformインスタンスへのパッチの適用: メソッド: post
パス: /api/v1/blockchainPlatforms/instances/{id}/patch
新規Blockchain Platformパッチの登録: メソッド: post
パス: /api/v1/blockchainPlatforms/patches
Blockchain Platformインスタンスでのパッチのロールバック: メソッド: post
パス: /api/v1/blockchainPlatforms/instances/{id}/rollback
Blockchain Platformインスタンスのスケール・イン: メソッド: post
パス: /api/v1/blockchainPlatforms/instances/{id}/scalein
Blockchain Platformインスタンスのスケール・アウト: メソッド: post
パス: /api/v1/blockchainPlatforms/instances/{id}/scaleout
Blockchain Platformインスタンスの起動: メソッド: post
パス: /api/v1/blockchainPlatforms/instances/{id}/action/start
Blockchain Platformインスタンスの停止: メソッド: post
パス: /api/v1/blockchainPlatforms/instances/{id}/action/stop
HSM接続のテスト: メソッド: post
パス: /api/v1/blockchainPlatforms/hsm/check
Blockchain Platformインスタンスの更新: メソッド: put
パス: /api/v1/blockchainPlatforms/instances/{id}

統計

統計操作用のREST API

現在のチャネルと各チャネルに参加しているピアの取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/channelInfo
指定したピアが参加しているチャネルの現在の数とリストの取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/channelsJoined
指定したピアにインストールされているチェーンコードの現在の数とリストの取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/chaincodeInstalled
指定したチャネルでインスタンス化されているチェーンコードの現在の数の取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/chaincodeInstantiated
ピアまたはオーダラのネイティブFabricメトリックの取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/metrics
ノードのヘルス・ステータスの取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/nodeHealth
非同期呼出し数の取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/proxyAsyncInvocation
請求可能トランザクション数の取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/billableTrans
ブロック数の取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/blocks
コミット数の取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/commits
エンドースメント数の取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/endorsements
同期呼出し数の取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/proxySyncInvocation
ピア、チャネルまたはネットワークのユーザー・トランザクション数の取得: メソッド: get
パス: /console/admin/api/v1.1/dashboard/statistics/userTrans