プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle API Managerの使用
12c (12.2.1.1.0)
E79333-01
目次へ移動
目次

前
前へ

8 Oracle API Managerの管理

この章では、Oracle API Managerの管理タスクについて説明します。

内容は次のとおりです。

8.1 「サブスクリプション」ページを使用したサブスクリプション統計の表示

ユーザーおよびAPIについてサブスクリプション統計を表示できます。ユーザーのサブスクリプション統計には、各ユーザーの作成されたアプリケーションと、そのアプリケーションにサブスクライブされているAPIが表示されます。

この項では、サブスクリプション詳細の表示方法について説明します。ここで説明されているタスクは、APIApplicationAdministratorロールを持つユーザーがAPI Manager Portalを使用して実行します。

8.1.1 ユーザーのサブスクリプションの表示

各ユーザーの作成されたアプリケーションと、そのアプリケーションにサブスクライブされているAPIを表示できます。

ユーザーのサブスクリプションを表示するには:

  1. 「サブスクリプション」ページで「ユーザー」をクリックします。「ユーザー」ページに、アプリケーションを作成したりAPIにサブスクライブしているユーザーごとに、作成されたアプリケーションの数とサブスクライブされているAPIの数が表示されます。
  2. 次の図に示すように、ユーザーの「詳細」アイコンをクリックして、そのユーザーの「詳細」ページを表示します。ユーザー詳細ページには、選択したユーザーが作成したアプリケーションがすべて表示されます。
  3. 詳細およびサブスクライブされているAPIを表示するアプリケーションの名前をクリックします。

8.1.2 APIのサブスクリプション詳細の表示

APIにサブスクライブしているユーザーおよびアプリケーションを表示できます。

APIのサブスクリプション詳細を表示するには:

  1. 「サブスクリプション」ページで、「API」をクリックして「API」パネルを表示します。サブスクリプションがある各APIが表示されます。「API」パネルには、サブスクライブしているユーザーの数と各APIに対するサブスクリプションの数が表示されます。
  2. APIの「詳細」アイコンをクリックしてAPI詳細ページの「使用状況」タブを表示します。このページでは、そのAPIにサブスクライブしているすべてのユーザーおよびアプリケーションがリストに表示されます。

8.1.3 クイック検索機能の使用方法

Oracle API Manager Portalには、問合せに一致するアプリケーションまたはAPIをすべて戻すクイック検索問合せが組み込まれています。クイック検索を使用して、空のアプリケーション、未使用のAPI (サブスクライブされていないAPI)および非推奨APIを戻すことができます。

クイック検索を実行するには:

  1. 「サブスクリプション」ページの「クイック検索」リージョンで、エントリのいずれか(「空のアプリケーション」「未使用のAPI」「非推奨API」)をクリックします。

    ヒント:

    「非推奨API」クイック検索は、ユーザーがサブスクライブされている非推奨APIのみを戻します。非推奨APIにサブスクリプションがない場合、そのAPIは「未使用のAPI」クリック検索によってのみ戻されます。

  2. (オプション) 「フィルタ」フィールドに検索用語を入力すると、クイック検索の結果をフィルタ処理できます。

8.2 Oracle API Managerでの分析の表示

API Manager Portalでは、使用状況およびパフォーマンス分析統計を表示できます。

ここで説明されているタスクは、APIApplicationAdministratorロールを持つユーザーが実行します。

注意:

分析データをAPI Managerに移入する場合、「API分析の有効化」で説明されているAPI分析の有効化が必要になることがあります。

8.2.1 API分析の有効化

API Managerで分析情報を有効にするには、Fusion Middleware Controlでプロキシ・サービスのモニタリング操作設定を有効にする必要があります。

注意:

分析はモニタリング操作設定が選択されているサービスでのみ使用可能です。分析情報へのアクセスが困難な場合、API分析が必要な各サービスに対し、モニタリングが有効なことを確認します。

API分析を有効にするには:

  1. Fusion Middleware Controlから、次のいずれかの方法でサービスを見つけます。
    • ドメイン全体でサービスを検索するには、ターゲット・ナビゲータで「SOA」を展開し、「service-bus」をクリックします。
    • Service Busプロジェクト内のサービスを検索するには、ターゲット・ナビゲータで「SOA」「service-bus」を開いて、検索するプロジェクトの名前を選択します。
  2. 操作」タブをクリックします。
  3. 使用する検索基準を指定して、その設定を変更するサービスを検索します。次の基準を指定できます。「タイプ」以外はすべてオプションです。
    • タイプ: 「プロキシ・サービス」を選択します。
    • 名前: 検索するサービスの名前を入力します。
    • パス: 検索するサービスのパス(プロジェクト名とフォルダ名、ある場合)。Service Busプロジェクトの「操作」タブの場合、パスにはすでに値が入力されています。

    ヒント:

    前述の条件のいずれも指定せずに検索すると、ドメインまたはプロジェクト内のすべてのサービスが返されます。

  4. 「検索」をクリックします。
  5. 結果リストの任意のプロキシ・サービスに対し、「モニター」チェック・ボックスを選択して対応するAPIのAPI分析を有効にするか、チェック・ボックスを選択解除してAPI分析を無効にします。

    ヒント:

    リストのすべてのサービスに対しAPI分析を有効または無効にするには、列見出しの横の「モニター」チェック・ボックスを選択または選択解除します。

  6. 「適用」をクリックします。
API分析が選択されたサービスに対して有効になりました。

8.2.2 APIの単純な分析の表示

「分析」ページを使用してAPIの単純な分析を表示できます。選択したAPIについて、合計メッセージ数を表すグラフ、集約間隔で受信したエラー・メッセージ数、平均レスポンス時間(ミリ秒)が表示されます。

APIの分析を表示するには、次の図に示すように、「分析」ページで単純な分析データを表示するAPIの「詳細」アイコンをクリックします。

次の図に示すように、データはページの右側にあるペインに表示されます。

表示される分析は、「統計の表示」リストで選択したオプションによって決まります。「現在の集約間隔」を選択して現在の集約間隔(詳細ページに表示される「期間」)のみの分析を表示するか、「最後のリセット以降」を選択して最後のリセット以降の分析統計を表示します。

8.2.3 APIの詳細な分析の表示

詳細ページでAPIのさらに詳細な統計を表示できます。API詳細ページのデータの説明は、「API詳細ページに表示される分析データ」を参照してください。

APIの詳細な分析を表示するには:

  1. 「カタログ」で、詳細な分析データを表示するAPIを見つけます。
  2. APIの「詳細」アイコンをクリックした後、「詳細」タブをクリックして詳細ページを表示します。
  3. (オプション)「統計の表示」リストから、「現在の集約間隔」を選択して現在の集約間隔(詳細ページに表示される「期間」)のみの分析を表示するか、「最後のリセット以降」を選択して最後のリセット以降の分析統計を表示します。

8.2.4 API詳細ページに表示される分析データ

API詳細ページにはAPIについて次のステータスが表示されます。

  • 管理対象ステータス: APIが管理対象か管理対象外かを示します。

  • 非推奨ステータス: APIが非推奨か非推奨以外かを示します。

次の図に、サンプルのAPI詳細ページを示します。

API詳細ページには、次の分析が表示されます。

  • 現在のAPIステータス: APIが稼働しているか停止しているかを示します。

  • エラー数: このAPIの起動時に受信したエラーの数が表示されます。

  • メッセージ数: APIから受信したメッセージの数が表示されます。

  • 時間間隔: 表示されたデータが集計された時間を表示します。

  • 平均レスポンス時間: 平均メッセージ・レスポンス時間(ミリ秒)が表示されます。集約間隔の変更の詳細は、『Oracle Service Busの管理』の「操作設定とグローバル設定の構成」を参照してください。

表示される分析は、「統計の表示」リストで選択したオプションによって決まります。「現在の集約間隔」を選択して現在の集約間隔(詳細ページに表示される「期間」)のみの分析を表示するか、「最後のリセット以降」を選択して最後のリセット以降の分析統計を表示します。

API詳細ページには、次のメタデータも表示されます。

要素 説明

APIプロファイル

APIに関連付けられている基本的なメタデータが表示されます。

API URL

APIのURLへのリンク。

バージョン

APIのバージョン情報が表示されます。

説明

APIの機能の詳細説明が表示されます。

タグ

APIに関連付けるタグのリストが表示されます。

管理

APIが管理対象か管理対象外かを示します。

SOAP

関連付けられたWSDLファイルのリンクが表示されます。

注意: このリージョンは、WSDLベースのSOAP APIの場合のみ表示されます。

WSDL

WSDLファイルへのリンクが表示されます。

OraWSDL

該当する場合、OraWSDLファイルへのリンクが表示されます。

REST

WADLファイルへのリンクが表示されます。

注意: このリージョンは、REST APIの場合のみ表示されます。

参照

APIの外部ドキュメント参照などの情報ソースが表示されます。

API詳細

APIの追加の詳細が表示されます。

セキュリティ概要

このAPIにアタッチするグローバル・セキュリティ・ポリシーの概要が表示されます。

セキュリティ・ポリシー

このAPIにアタッチされたセキュリティ・ポリシーが表示されます。ポリシーにカーソルを合せて「詳細」アイコンをクリックすると、ポリシーの説明が表示されます。

非推奨

APIが非推奨か非推奨以外かを示します。

テスト中

APIのテストURLが表示されます。

8.3 APIおよびAPIキュレーション・メタデータのインポートとエクスポート

ある環境から別の環境に移動する場合、APIおよびAPIメタデータを最初の環境からエクスポートした後、データをその他の環境にインポートする必要があります。 その他の環境にデータを簡単に移行できるように、Oracle API Managerでは、インポート機能とエクスポート機能が公開されています。

この項では、インポート機能とエクスポート機能の使用方法について説明し、テスト環境から本番環境にAPIとAPIメタデータを移行する際に使用するサンプルのWLSTスクリプトを示します。ここで説明されているタスクは、DeployerロールまたはIntegrationAdministratorロールを持つユーザーが実行します。

8.3.1 環境からのエクスポート

環境からデータをエクスポートするには:

  1. 『Oracle Service Busでのサービスの開発』のコンソールで構成JARファイルにリソースをエクスポートする方法に関する項のタスクを完了して、Oracle Service Busコンソールから必要なプロジェクトおよびリソースが含まれる構成JARファイルをエクスポートします。
  2. WLSTを使用するように環境が設定されていることと、必要なライブラリが組み込まれていることを確認します。<MW_HOME/osb/lib/apimanager-client.jarにあるJARファイルは、API Managerのインポートおよびエクスポートのコールが機能するようにクラスパスの中に入れる必要があります。

    WLSTの使用方法の詳細はOracle Fusion Middlewareの管理のOracle WebLogic Scripting Tool (WLST)の使用のスタート・ガイドに関する項を、API ManagerのAPI参照ドキュメントはAPI Manager Javaリファレンスを参照してください。

  3. Service Busコンソールから、WLSTスクリプトを作成してキュレーション・メタデータJARファイルをエクスポートします。サンプルのWLSTエクスポート・スクリプトについては、「キュレーション・メタデータをエクスポートするためのサンプル・スクリプト」を参照してください。
  4. スクリプトを実行します。キュレーション・メタデータがJARファイルにエクスポートされます。名前および場所はスクリプトで定義したプロパティによって決定されます。

8.3.2 キュレーション・メタデータをエクスポートするためのサンプル・スクリプト

次の例は、変更可能で、Service Busコンソールからキュレーション・メタデータをエクスポートするために使用される、サンプルのexportCuration.pyスクリプトを表します。

例 - キュレーション・メタデータをエクスポートするためのサンプルのexportCuration.pyスクリプト

from oracle.apimanager.importexport import CatalogExportPlan
 
hostname = sys.argv[1]
port = sys.argv[2]
username = sys.argv[3]
password = sys.argv[4]
 
connect(username, password,'t3://'+hostname+':'+port)
 
domainRuntime()
cd('DomainServices/AdminService')
 
print '*********Exporting curation metadata...'
#export curation metadata for all projects
explan=CatalogExportPlan()
 
filename='<file_path>/<file_name>'
 
print '*********Exporting curation metadata to' + str(filename)
exportedjar=cmo.exportCatalog(explan)
exportfile=open(filename, 'wb')  
exportedjar.tofile(exportfile)
exportfile.close()  
print '*********Export curation metadata finished...'
 
print '*********Exiting...'
exit()

8.3.3 環境へのインポート

環境にデータをインポートするには:

  1. 『Oracle Service Busでのサービスの開発』のセッションの作成方法に関する項のタスクを完了して、Oracle Service Busコンソールで新しいセッションを作成します。
  2. 『Oracle Service Busでのサービスの開発』のコンソールで構成JARファイルからリソースをインポートする方法に関する項のタスクを完了して、「環境からのエクスポート」の手順1で作成した構成JARをService Busコンソールにインポートします。
  3. 『Oracle Service Busでのサービスの開発』のセッションのアクティブ化方法に関する項の手順を完了して、Service Busセッションをアクティブにします。
  4. WLSTを使用するように環境が設定されていることと、必要なライブラリが組み込まれていることを確認します。<MW_HOME/osb/lib/apimanager-client.jarにあるJARファイルは、API Managerのインポートおよびエクスポートのコールが機能するようにクラスパスの中に入れる必要があります。

    WLSTの使用方法の詳細はOracle Fusion Middlewareの管理のOracle WebLogic Scripting Tool (WLST)の使用のスタート・ガイドに関する項を、API ManagerのAPI参照ドキュメントはAPI Manager Javaリファレンスを参照してください。

  5. 「環境からのエクスポート」の手順3で作成したキュレーション・メタデータJARファイルを、Service BusコンソールにインポートするWLSTスクリプトを作成します。サンプルのWLSTインポート・スクリプトについては、「キュレーション・メタデータをインポートするためのサンプル・スクリプト」を参照してください。
  6. スクリプトを実行します。JARからメタデータがService Busコンソールにインポートされます。APIメタデータは、APIが公開されるとAPI Manager Portalに表示されます。

8.3.4 キュレーション・メタデータをインポートするためのサンプル・スクリプト

次の例は、変更可能で、Service Busコンソールにキュレーション・メタデータをインポートするために使用される、サンプルのimportCuration.pyスクリプトを表します。

例 - キュレーション・メタデータをインポートするためのサンプルのimportCuration.pyスクリプト

from oracle.apimanager.importexport import CatalogImportPlan
from java.util import HashSet
 
hostname = sys.argv[1]
port = sys.argv[2]
username = sys.argv[3]
password = sys.argv[4]
 
connect(username, password,'t3://'+hostname+':'+port)
 
domainRuntime()
cd('DomainServices/AdminService')
 
print 'Importing curation metadata...'
implan=CatalogImportPlan()
 
#select projects to be imported
#if project set is empty, all projects will be included
projects=HashSet()
projects.add('SOAPProject')
implan.setProjects(projects)
 
print 'import plan: '
getproj=implan.getProjects()
for gp in getproj:
	print str(gp)
 
jar=open('<file_path>/<file_name>', "rb").read()
 
result=cmo.importCatalog(jar,implan)
jar.close()
print 'Import curation metadata finished...'
 
print '*********Printing All entries in archive...'
content=result.getContent()
for ct in content:
	print ct.getFullName()
 
print '*********Printing imported entries...'
importset=result.getImported()
for ref in importset:
	print ref.getFullName()
 
print '*********Printing skipped entries...'
skipset=result.getSkipped()
for skref in skipset:
	print skref.getFullName()
 
print '*********Exiting...'
exit()