1. Oracle Blockchain Platform REST API Oracle Blockchain Platform Enterprise Edition REST API
  2. 新規API、変更済APIおよび非推奨のAPI

新規API、変更済APIおよび非推奨のAPI

新規、変更済または非推奨のリソース・パスとエンドポイントについて、次の内容を確認します。

追加または変更されたリソース・パスとエンドポイント

これらのリソース・パスおよびエンドポイントは、以前のOracle Blockchain Platformリリースから変更されたか、このリリースでは機能が若干異なっている可能性があります。

エンドポイント リソース・パス 機能変更
ブロックの検証 /console/admin/api/v1.1/nodes/peers/{peerId}/blockaudit/{channelName} このエンドポイントは、指定されたピアが所有するチャネルに対して台帳ブロックを検証するために使用されます。

RESTプロキシ・ノードの構成の更新

/console/admin/api/v1.1/nodes/restproxies/{restProxyId}

 以前のバージョンでは、このAPIを使用して、指定したRESTプロキシ・ノードでチャネルおよびチェーンコードを構成できました。v21.1.2以降では、このAPIを使用して待機時間およびログ・レベルを指定できますが、Blockchain Platformアーキテクチャが更新されたため、チャネル、チェーンコードおよびエンドーサのパラメータが有効ではなくなりました。

Blockchain Platformオーダラ操作

オーダリング・サービス・ノード(OSN)およびネットワーク構成ブロックを操作するための新しいエンドポイントがいくつかあります:

  • /console/admin/api/v1.1/nodes/orderers/{ordererId}/exportOSN
  • /console/admin/api/v1.1/nodes/orderers/{ordererId}/importNCB
  • /console/admin/api/v1.1/channels/{channelName}/orderers/joinOSN
  • /console/admin/api/v1.1/channels/{channelName}/orderers/removeOSN
  • /console/admin/api/v1.1/channels/syschannel/configblock
  • /console/admin/api/v1.1/channels/syschannel/addOSN

これらのエンドポイントは、新しいRaftオーダリング・サービスをサポートするために追加されました。これらを使用すると、オーダリング・サービス・ノードを追加および削除したり、ネットワーク構成ブロックをエクスポートまたはインポートできます。

複数ノードのエンドポイント
  • /console/admin/api/v1.1/nodes/peers/{peerID}/start|stop
  • /console/admin/api/v1.1/nodes/orderers/{ordererID}/start|stop
  • /console/admin/api/v1.1/nodes/fabricCAs/{caId}/start|stop
  • /console/admin/api/v1.1/nodes/restproxies/{restProxyId}/start|stop

これらのAPIにはペイロードがありません。以前は、ヘッダーにコンテンツの長さを指定する必要はありませんでした。v21.1.2以降では、-H "content-length: 0"パラメータを使用してコンテンツの長さを指定する必要があります。

RESTプロキシAPIのバージョンの取得 既存のREST API:
  • /{restproxy}/bcsgw/rest/version
このリリースでも引き続きサポートされていますが、v21.1.2では類似しているが機能が異なる新しいREST APIで置き換えられています。
  • /restproxy/api/v2/version
  

チェーンコードの問合せ

/restproxy/api/v2/channels/{channelId}/chaincode-queries

 v21.1.2以降では、CouchDB配列演算子の場合、範囲問合せおよびページ区切りはサポートされていません。

トランザクション情報の取得

 /restproxy/api/v2/channels/{channelId}/transactions/{transactionId} v21.1.2以降では、非同期呼出し提案の失敗の問合せはサポートされていません。

指定したトランザクションのステータスの表示

 既存のREST API:
  • /{restproxy}/bcsgw/rest/v1/transaction
このリリースでも引き続きサポートされていますが、v21.1.2では類似しているが機能が異なる新しいREST APIで置き換えられています。
  • /restproxy/api/v2/channels/{channelId}/transactions/{transactionId}

以前のBlockchain Platformバージョンでは、{restproxy}は別の残りのプロキシ・ノードに設定できる変数です。v21.1.2以降では、{restproxy}はパスの文字列"restproxy"として修正されています。

トランザクションの呼出し

 既存のREST API:
  • /{restproxy}/bcsgw/rest/v1/transaction/asyncInvocation
  • /{restproxy}/bcsgw/rest/v1/transaction/invocation
引き続きサポートされていますが、v21.1.2では、類似しているが機能が異なる新しいREST APIに置き換えられています:
  • /restproxy/api/v2/channels/{channelId}/transactions

以前のBlockchain Platformバージョンでは、{restproxy}は別の残りのプロキシ・ノードに設定できる変数です。v21.1.2以降では、{restproxy}はパスの文字列"restproxy"として修正されています。

v21.1.2以降では、トランザクション送信時のコールバックのサポートは非推奨になりました。または、「トランザクション情報の取得」APIを使用してトランザクション・ステータスを手動で問い合せるか、「イベントのサブスクライブ」APIを使用してトランザクション・イベントへのコールバックを作成できます。

以前のBlockchain Platformバージョンでは、トランザクション呼出しはデフォルトで同期されていました。v2では、デフォルトで非同期になっています。トランザクションを同期的に呼び出すには、リクエストのJSON本文で"sync"= trueを設定します。

イベント・サブスクリプション

 既存のREST API:
  • /{restproxy}/bcsgw/rest/v1/event/subscribe
  • /{restproxy}/bcsgw/rest/v1/event/unsubscribe
  • /{restproxy}/bcsgw/rest/v1/event/querySub
このリリースでは引き続きサポートされていますが、v21.1.2では、類似しているが機能が異なる新しいREST APIに置き換えられています:
  • /restproxy/api/v2/channels/{channelId}/event-subscriptions

以前のBlockchain Platformバージョンでは、{restproxy}は別の残りのプロキシ・ノードに設定できる変数です。v21.1.2以降では、{restproxy}はパスの文字列"restproxy"として修正されています。

Hyperledger Fabricの新しいリリースでは、イベントはチャネルがスコープ指定されます。次のイベント・タイプのサブスクライブは、v21.1.2ではまだサポートされていません:
  • txOnChannel
  • txOnNetwork
  • blockOnNetwork
  • chaincodeEvent

非推奨になったリソース・パスとエンドポイント

これらのリソース・パスとエンドポイントは非推奨になりました。

エンドポイント 非推奨になったリリース・バージョン リソース・パス

構成されたチェーンコードのリストの取得

 21.1.2 /console/admin/api/v1.1/dashboard/statistics/proxyConfiguredCC

ピア・ノードの追加

 21.1.2 /console/admin/api/v1.1/nodes/peers

ノードのエクスポート

 21.1.2 /console/admin/api/v1.1/nodes/export

ノードのインポート

 21.1.2 /console/admin/api/v1.1/nodes/import

ピア・ノードの削除

 21.1.2 /console/admin/api/v1.1/nodes/peers/{peerId}

チャネル構成の更新

 19.1.3 /console/admin/api/v1.1/channels/{channelName}

ノート:

  • 非推奨になったリソース・パスとエンドポイントはリストされたリリースで廃止されます。つまり、そのバージョンを使用してファウンダ・インスタンスを作成するか、または既存のインスタンスをアップグレードすると、これらのエンドポイントは使用できなくなるということです。
  • できるだけ速やかにアプリケーションを移行して、新しいパスとエンドポイントを使用することをお薦めします。今後、非推奨のURL構造がサポートされなくなったときに、中断が最小限で済みます。