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

このページでは、以前のリリースからの新規、変更済または非推奨のリソース・パスおよびエンドポイントについて説明します。

このドキュメントは、Hyperledger Fabric v2.5以降のOracle Blockchain Platform REST APIに固有です。Oracle Blochain Platform Enterprise Edition v21.1以前を使用している場合は、プラットフォームでHyperledger Fabric v1.4が使用されています。『Oracle Blockchain Platform Enterprise Edition REST API v21.1』を参照してください。

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

既存のAPIのほとんどに、新しいHyperledger Fabric v2.5に相当するものがありますが、1対1の対応関係にはなっていません。APIの中には、Hyperledger Fabricの各バージョンに固有のものもあれば、リリースごとに異なるパラメータを持つものもあります。

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

エンドポイント		リソース・パス	機能変更
アプリケーション操作
	バージョン	ブロックチェーン・プラットフォーム、Hyperledger Fabricおよび管理APIのバージョンを取得: /console/admin/api/instanceVersion	24.1の新機能。Oracle Blockchain Platform、Hyperledger Fabricおよび管理APIのバージョンを問い合せることができます。
	監査ログ・イベント	Hyperledger Fabric v2.5ベース・パス /restproxy/api/v2/auditlog	24.1の新機能。REST APIエンドポイントから監査ログ情報を取得できます。監査ログは、チャネル、組織、ノードおよびチェーンコードに関連するアクションなど、管理コンソール・アクティビティの記録です。
	アトミック・トランザクション	Hyperledger Fabric v2.5ベース・パス /restproxy/api/v2/atomicTransactions	24.1の新機能: アトミック・トランザクションがサポートされています。アトミック・トランザクションは、すべて成功するか、いずれも成功しないかのどちらかになる、分割できない一連のデータ操作です。 最終リソース・コミット(LRC)パラメータを使用して、アトミック・トランザクション・ワークフローにEthereumベースのトランザクションを含めることができます。 アトミック・トランザクションを使用し、最終リソース・コミット(LRC)パラメータを使用して、Oracle Blockchain PlatformからEthereumまたはPolygonネットワークにNFTを転送できます。アトミック・トランザクションに関する項を参照してください。
	イベント	Hyperledger Fabric v1.4ベース・パス /restproxy/api/v2/channels/{channelId}/event-subscriptions Hyperledger Fabric v2.5ベース・パス /restproxy/api/v2/channels/{channelName}/event-subscriptions	Hyperledger Fabric v1.4のchannelIdは、すべてのHyperledger Fabric v2.5エンドポイントでchannelNameになりました。 他のすべてのエンドポイントは、以前のリリースと同様に引き続き機能しますが、新しいベースパスを使用します。 24.1の新機能: イベントのサブスクライブ中に、オプションでコールバック再試行の最大数を選択できるようになりました。 TLSに加えて、OAuth 2.0で保護されたコールバック・エンドポイントを呼び出すことができます。 seekパラメータは、ブロックおよびコードブロックに限定されなくなりましたが、チェーンコード・イベントも返されるようになりました。
	トランザクション	Hyperledger Fabric v1.4ベース・パス /restproxy/api/v2/channels/{channelId} Hyperledger Fabric v2.5ベース・パス /restproxy/api/v2/channels/{channelName}	Hyperledger Fabric v1.4のchannelIdは、すべてのHyperledger Fabric v2.5エンドポイントでchannelNameになりました。 Fabric v2.5の新機能として、トランザクションを送信するときに、isInitパラメータを使用して、初期化リクエストであるかどうかをオプションで指定できるようになりました。 他のすべてのエンドポイントは、以前のリリースと同様に引き続き機能しますが、新しいベースパスを使用します。 非同期トランザクションに固有の2つの新しいエンドポイントが追加されました: 非同期トランザクションの送信 非同期トランザクションのレスポンスの取得
ブロックチェーン・ネットワーク管理操作			すべてのブロックチェーン・ネットワーク管理操作がv1.1からv2に更新されました。すべてのエンドポイントがこの新しいベースパスを使用します。
	チェーンコード	次のベース・パスのHyperledger Fabric v1.4 APIは: /console/admin/api/v1.1/chaincodes 新しい関数を含むHyperledger Fabric v2.5 APIに置き換えられました: /console/admin/api/v2/chaincodes	チェーンコードのライフサイクルは、Hyperledger Fabric v1.4とv2.5で異なります。そのため、Hyperledger Fabric v2.5では、使用可能なエンドポイント、そのパラメータ、および機能が新しくなっています。 REST APIコールを新しいプラットフォーム・レベルに移行する前に、新しいライフサイクルのドキュメントをよくお読みください。 これらの変更の詳細は、Hyperledger Fabricドキュメントの「Fabric chaincode lifecycle」を参照してください。 Oracle Blockchain Platformでの新しいチェーンコード・デプロイメント・ライフサイクルの詳細は、Hyperledger Fabric 2.5でのチェーンコードでのデプロイおよび管理に関する項を参照してください。 24.1の新機能。インストール済のチェーンコード・パッケージを削除して、インスタンスのストレージ領域を解放できます。
	チャネル	Hyperledger Fabric v1.4ベース・パス /console/admin/api/v1.1/channels Hyperledger Fabric v2.5ベース・パス /console/admin/api/v2/channels	Hyperledger Fabric v2.5の新しいエンドポイント チャネルでのチェーンコード定義の承認: /{channelName}/chaincodeDefinitions/approve コミット準備状況の確認: /{channelName}/chaincodeDefinitions/checkCommitReadiness チャネルでのチェーンコード定義のコミット: /{channelName}/chaincodeDefinitions/commit チャネルのチェーンコード定義の問合せ: /{channelName}/chaincodeDefinitions 他のすべてのチャネル・エンドポイントは、以前のリリースと同様に引き続き機能しますが、新しいベースパスを使用します。
	ノード	Hyperledger Fabric v1.4ベース・パス /console/admin/api/v1.1/nodes Hyperledger Fabric v2.5ベース・パス /console/admin/api/v2/nodes	Hyperledger Fabric v2.5で変更されたエンドポイント RESTプロキシのカスタム登録の作成: /restproxies/{restProxyId}/enrollments このエンドポイントでは、オプションで、文字列値属性を持つカスタム・キーを登録証明書に追加できるようになりました。 RESTプロキシ・ノードの構成の取得: /restproxies/{restProxyId} このエンドポイントは、ノード構成がトランザクション・イベントをログに記録するかどうかを返すようになりました。 ピア・ノードの構成の更新: /peers/{peerId} チェーンコードとゴシップのピア構成属性が、Hyperledger Fabric v2.5で変更されました。 RESTプロキシ・ノードの構成の更新: /restproxies/{restProxyId} オプションでトランザクション・イベントをログに記録できるようになりました。 他のすべてのノード・エンドポイントは、以前のリリースと同様に引き続き機能しますが、新しいベースパスを使用します。
	組織	Hyperledger Fabric v1.4ベース・パス /console/admin/api/v1.1/organizations Hyperledger Fabric v2.5ベース・パス /console/admin/api/v2/organizations	すべての組織エンドポイントは、以前のリリースと同様に引き続き機能しますが、新しいベースパスを使用します。
Blockchain Platform管理操作
	構成	Oracle Blockchain Platform 21.1および24.1のベース・パス /api/v1/configuration	2つの新しい構成エンドポイントがあります: デフォルトLDAPサーバーへのユーザーの追加 ログイン後の構成詳細の取得
	プラットフォーム	Oracle Blockchain Platform 21.1および24.1のベース・パス /api/v1/blockchainPlatform	これらのAPIはOracle Blockchain Platform 21.1と24.1の間で変更されていませんが、ロード・バランサ、HSMおよびパッチ適用のエンドポイントは24.1では使用できません。
統計		Hyperledger Fabric v1.4ベース・パス /console/admin/api/v1.1/dashboard/statistics Hyperledger Fabric v2.5ベース・パス /console/admin/api/v2/dashboard/statistics	Hyperledger Fabric v2.5で非推奨になったエンドポイント 指定したピアにインストールされているチェーンコードの現在の数とリストの取得: /chaincodeInstalled 指定したチャネルでインスタンス化されているチェーンコードの現在の数の取得: /chaincodeInstantiated 請求可能トランザクション数の取得: /billableTrans Hyperledger Fabricバージョン間のチェーンコード・ライフサイクルの変更により、プラットフォームを新しいバージョンに移行すると、以前のバージョンのライフサイクルに関連する統計は非推奨になります。 非推奨でないエンドポイントはすべて、以前のリリースと同様に引き続き機能しますが、新しいベースパスを使用します。

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

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

エンドポイント	非推奨になったリリース・バージョン	リソース・パス	追加情報
ブロックチェーン・ネットワーク管理操作	Hyperledger Fabric v2.x	チェーンコード情報の取得: /console/admin/api/v1.1/chaincodes/{chaincodeName} チェーンコードのインスタンス化: /console/admin/api/v1.1/chaincodes/{chaincodeName}/instantiate	Hyperledger Fabricバージョン間のチェーンコード・ライフサイクルの変更により、プラットフォームを新しいバージョンに移行すると、以前のバージョンのライフサイクルに関連する管理操作は非推奨になります。 Hyperledger Fabic v2.2にまだ移行していない場合は、これらは引き続き機能します。
統計	Hyperledger Fabric v2.x	指定したピアにインストールされているチェーンコードの現在の数とリストの取得: /console/admin/api/v1.1/dashboard/statistics/chaincodeInstalled 指定したチャネルでインスタンス化されているチェーンコードの現在の数の取得: /console/admin/api/v1.1/dashboard/statistics/chaincodeInstantiated 請求可能トランザクション数の取得: /console/admin/api/v1.1/dashboard/statistics/billableTrans	Hyperledger Fabricバージョン間のチェーンコード・ライフサイクルの変更により、プラットフォームを新しいバージョンに移行すると、以前のバージョンのライフサイクルに関連する統計は非推奨になります。 Hyperledger Fabic v2.2にまだ移行していない場合は、これらは引き続き機能します。

ノート:

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