FUJITSU Cloud Service K5 API Management サービス仕様書

FUJITSU Cloud Service K5 API Management サービス仕様書
2016 年 7 月 31 日
1.
サービス仕様
本サービスは、
Apigee 社が提供する統合 API プラットフォーム製品である Apigee Edge をベースとしたサービスです。
契約番号に対して1つの Organization(組織)を利用することができます(Organization(組織)は、本サービスの管
理単位です)
。1つの組織に対して、テスト向け、本番向けの 2 つの Environment(環境)を利用することができます。
本サービスは、
以下の機能を提供し、契約者は Pro または Standard を選択できます。
なお、
契約者が設定した API Proxy
をバックエンドサービスに接続するアプリケーションが呼び出すことを「コール」というものとし、本サービスの利用
料金はコールの数量に応じて当社から別途提供される料金表のとおり定められるものとします。
Pro/Standard
(1)
ゲートウェイサービス
Web アクセスが可能なアプリケーションを、他のアプリケーションから接続するための機能を以下のとおり提供します
(ゲートウェイサービスを通じて接続される Web アクセスが可能なアプリケーションを、以下「バックエンドサービ
ス」という)
。
①
APIs
バックエンドサービスの API の構成管理および開発を支援するための機能を提供します。
i.
API Proxies
契約者は、所定の情報を入力することで、API Proxy(バックエンドサービスと、バックエンドサービスに
接続されるアプリケーション間の処理を実行するサービスの単位をいう)を作成し、ポリシーおよびフローを
設定することができます。契約者は、作成した API Proxy をテスト向けまたは本番向けの Environment に配
備し、また、API Proxy が処理するリクエストやレスポンス等の動作を可視化して表示するトレース機能を利
用することができます。
・ポリシー
契約者は、API Proxy に、以下のとおりポリシーを設定することができます。
ポリシーの種類
説明
TRAFFIC MANAGEMENT
バックエンドサービスへのリクエスト件数や同時接続件数の制限および所定
(トラフィック制御ポリシー)
SECURITY
(セキュリティポリシー)
MEDIATION
(仲介型ポリシー)
EXTENSION
(拡張用ポリシー)
の情報や処理の結果のキャッシュとしての保存等を設定できます。
バックエンドサービスの API へのアクセス認証および XML 形式や JSON 形
式のメッセージの送受信への制限の追加等を設定できます。
バックエンドサービスと、バックエンドサービスに接続されるアプリケーシ
ョン間でメッセージの送受信を行う際のフォーマット変換等を設定できま
す。
所定の条件に応じて Java Script や外部のサービスの実行およびデータの収
集および保存等を設定できます。
・フロー
契約者は、API Proxy にフローを設定することで、ポリシーの実行タイミングを制御することができます。
ii.
Environment Configuration
バックエンドサービスからのレスポンスや任意のデータ等、API Proxy のトラフィック制御ポリシーで扱
うキャッシュの分類を作成できます。
②
Publish
バックエンドサービスの API を、1つ以上の API Proxy のグループ(以下「API Product」という)を通し
て本番向けの Environment で利用できるようにするための機能を提供します。
i.
Product
API Product を作成することができます。API Product に対しては、一括でポリシーやフローを設定するこ
とが可能になります。
ii.
Developer
任意の人を、Developer として登録できます。
iii.
Developer Apps
バックエンドサービスと接続されるアプリケーション、1人の Developer および1つ以上の API Product
の組合せに対して、固有の API Key を生成することができます。Developer をこれにより生成された API Key
を利用してバックエンドサービスにアクセスさせることで、バックエンドサービスに接続する Developer を特
定したり、Developer 毎にアクセスを制限することができます。
(2)
アナリティクスサービス
①
Analytics
API トラフィックの情報を集計・解析し、モニタリングすることで、以下のとおり API Proxy や Developer の利
用状況やパフォーマンス等を解析できます。
解析パターン
Proxy Performance
説明
API Proxy のトラフィック量と平均応答時間をグラフ化しま
す。
機能提供
Pro
Standard
○
○
○
-
○
-
○
○
○
-
○
-
○
○
○
○
○
○
○
△(※)
全バックエンドサービスへのトラフィック量とリクエストの
Target Performance
成功・失敗件数、応答時間、レスポンスの成功・失敗件数、ペ
イロードサイズをグラフ化します。
Cache Performance
Latency Analysis
Error Analysis
Developer Engagement
Traffic Composition
トラフィック制御ポリシーを通じて処理されたキャッシュヒ
ット率や件数、応答時間をグラフ化します。
API Proxy の応答時間や、バックエンドサービスの応答時間を
グラフ化します。
API Proxy が処理するリクエストおよびレスポンスで発生した
エラーの情報(件数やステータスコード等)をグラフ化します。
Developer の人数やアクセス状況、トラフィック量、エラー率
をグラフ化します。
API Proxy、API Product、Developer、アプリケーションのト
ラフィック量 Top10 をグラフ化します。
指定した URI で特定されるバックエンドサービスへのトラフ
Business Transactions
ィック量、平均応答時間、エラー率、通信量(リクエストとレ
スポンスのデータサイズ合計)をグラフ化します。
API Proxy に対するアクセス元のデバイス情報(プラットフォ
Devices
ーム、エージェント、デバイスタイプ、OS 種別等)をグラフ
化します。
縦軸(Metrics)および横軸(Dimensions)、ならびに統計
Custom Reports
期間を所定の項目から自由に選択して、情報をグラフ化しま
す。
※一部縦軸および横軸のみ表示可能
契約者が Pro から Standard に変更する場合、アナリティクスサービスのために保持されていた詳細なデータ
(API の 1 リクエストにつき 1 件取得するログをいい、以下同じ)は、当該変更時に削除されます。また、契約者
が Standard から Pro に変更する場合、当該変更時から、アナリティクスサービスのための詳細なデータ取得が開
始されます。
(3)
その他の機能
Admin
①
ユーザー(本サービスが提供する機能を利用したり、資源を管理したりする「人」を表します)を登録し、また
ユーザー毎にロールを指定することで、以下の機能に対するアクセス権限を設定できます。

APIs の API Proxies と Environment Configuration

Publish の Product と Developers Apps

Analytics の Custom Reports
初期設定として以下のデフォルトロールを指定できます。
デフォルトロール
説明
全て利用可能な機能
User
Operations
Administrator
テスト向け Environment への API Proxy の配備
参照のみ利用可能な機能
本番向け Environment への API Proxy の配備、Publish、Analytics
利用できない機能
Environment Configuration、Admin
全て利用可能な機能
Business User
API Proxy のポリシーとフローの設定、API Proxy のトレース機能
参照のみ利用可能な機能
API Proxy のトレース機能、
テスト向け Environment への API Proxy
の配備、Publish、Analytics
API Proxy のポリシーとフローの設定、本番向け Environment への
API Proxy の配備
利用できない機能
Environment Configuration、Admin
全て利用可能な機能
API Proxy の配備、API Proxy のトレース機能
参照のみ利用可能な機能
API Proxy のポリシーとフローの設定、Publish、Analytics
利用できない機能
Environment Configuration、Admin
Organization
Administrator
全ての機能を利用可能
デフォルトロールに加え、任意にアクセス権限を設定したロールを新規に作成することができます。
2.
提供条件
(1)
契約者は、API Proxy を通して送受信されるデータについて、当社が本サービスの提供のために受信、保存、処
理および利用することを許諾するものとします。
(2)
契約者は、バックエンドサービスの API および API Proxy のアクセス制御および管理について責任を持つものと
します。これらが第三者に使用されたことにより契約者または第三者に生じた損害について、当社は何ら責任を
負わないものとします。
(3)
本サービスを構成するソフトウェアは適宜更新されることがあり、当社が事前の通知なく修正ソフトウェアを適
用することを契約者は了承するものとします。
(4)
本サービスを構成するソフトウェアは Apigee 社およびそのライセンサーに権利が帰属するものであり、当社は
Apigee 社の許諾に基づき本サービスを提供しています。従って、契約者が本サービスの利用に関して利用規約に
違反した場合、Apigee 社が契約者に対して利用規約に基づく権利を当該許諾の範囲内で契約者に直接行使する場
合があり、契約者はこれに同意するものとします。
(5)
契約者は、本サービスの利用に関して、一切の請求または問い合わせを Apigee 社に対して直接行なってはならな
いものとします。
3.
制限事項
(1)
本サービスを利用できるクライアント環境については、以下のウェブサイトをご参照ください。
https://apimng.jp-east-1.paas.cloud.global.fujitsu.com/docs/requirements.pdf
(2)
本サービスは、東日本リージョン 1 および UK リージョン 1 で提供します。
4.
注意事項
(1) 本サービスは、契約者が当社所定の方法で利用設定申込を行った後、当社が利用設定を完了した時点で開始される
ものとし、本サービスの利用料金として、利用設定の完了日の属する料金月から所定の月額利用料金(満額)が発
生するものとします。
(2) 本サービスで利用できる Environment に API Proxy を配備することにより、API Proxy はインターネットに公開
された状態となります。契約者は、API Proxy のアクセス制御および管理ならびにその他セキュリティ全般につい
て単独で責任を負うものとします。
(3) 契約者が Pro および Standard 間で変更を希望する場合は、事前に当社所定の方法で当社にその旨連絡するものと
します。
以 上
附則(2016 年 2 月 1 日)
本サービス仕様書は、2016 年 2 月 1 日から適用されます。
附則(2016 年 3 月 17 日)
本サービス仕様書は、2016 年 4 月 1 日から適用されます。
附則(2016 年 7 月 1 日)
本サービス仕様書は、2016 年 7 月 1 日から適用されます。
附則(2016 年 7 月 31 日)
本サービス仕様書は、2016 年 7 月 31 日から適用されます。