FAQ

API Management に関する FAQ を掲載しています。



サービス全般

Q : FUJITSU Hybrid IT Service FJcloud-O API Management とは?

A : FUJITSU Hybrid IT Service FJcloud-O の PaaS のひとつとして提供される Web API の Gateway サービスです。
Web API サービスを提供されているプロバイダ様や、システムに Web API のインタフェースを開発予定のお客様に価値をもたらすサービスです。 API Management は、API を提供するサービスとそれを利用するクライアントアプリとの間に位置し、API の Gateway として機能します。
API Management は、トラフィック制御、認証、セキュリティ、ペイロード加工などのさまざまな機能を備えています。 API Management 経由で API を実行することで、API にそれらの機能を持たせることができるほか、API 自体の開発も可能です。

Q : API Management を利用するメリットは?

A : 下記のようなメリットがあります。

  • コーディングなしで機能を追加できるため、API 開発のコストダウンに繋がります。
  • デバッグ機能、デプロイ機能、開発用環境などの開発機能を利用することで、効率的な開発を実現します。
  • API の詳細な統計をグラフィカルに確認できるため、パフォーマンス改善、エラー検知、利用状況確認に役立ちます。
  • API のパッケージング機能によりビジネスプランに合わせた柔軟な API 製品の提供が可能です。
Q : 既存の API を API Management を介して利用する場合、エンドユーザがアクセスする URL は変わりますか?

A : 「API Management ゲートウェイ拡張」をご利用いただきますと、当社から提供する ".paas.cloud.global.fujitsu.com" ドメインではなく、お客様独自のドメイン名を利用することにより、URL を変更することなくご利用頂けるケースがあります。 独自ドメイン名の利用をご希望の際には、ヘルプデスクよりお問い合わせください。
なお、お客様にて下記の作業が必要になります。

  • DNS サーバへの CNAME の設定 (独自ドメインを当社ドメインに向ける設定)
  • (HTTPS にて API をご利用される場合) SSL 証明書のご登録
Q : API Management を介することでどの程度の遅延が生じますか?

A : API Management で API に追加する機能の数や、処理の重さに依存します。

Q : バックエンドに指定するサービスに制限はありますか?

A : インターネット経由でアクセスできる HTTP ベースのサービスであれば指定可能です。

Q : API を利用するクライアント向けの SDK はありますか?

A : クライアント向け SDK は提供しておりません。
API のリクエスト及びレスポンスの仕様については、API Management 側から指定する部分はないため、各言語で提供されている一般的なライブラリをご利用頂けます。

Q : API 実行時に HTTPS を利用できますか?

A : HTTP に加え、HTTPS もご利用いただけます。

Q : API の利用状況に対してアラートを設定できますか?

A : アラートなどの自動監視機能はございません。

Q : API の利用状況を確認できますか?

A : Analytics 機能により下記を確認できます。

  • レスポンス数
  • レスポンス時間
  • キャッシュのヒット率
  • エラー統計
  • リクエストを実行したアプリ毎の統計
API Proxy 別やアプリ別での表示、フィルターやドリルダウン機能を備えており、詳細な統計を確認できます。
また、統計情報取得用 WebAPI を利用すれば、利用状況をダウンロードすることもできます。
機能

Q : API Management で API にどのような機能を追加できますか?

A : 大別して 4 つの機能を API に追加できます。

  • トラフィック制御
    • 単位時間あたりのリクエスト数
    • バックエンドサービスへの同時接続数
    • キャッシュ

  • ペイロード加工
    • データ形式の変換
    • リクエスト/レスポンスデータの編集

  • 認証/セキュリティ
    • OAuth2.0
    • API Key 認証
    • IP 制限
    • Web フィルタリング

  • 拡張
    • ユーザースクリプト(JavaScript)の実行
    • 複数のバックエンドサービスから受け取ったレスポンスデータのマッシュアップ
Q : API のペイロードの形式に指定はありますか?

A : ありません。
JSON や XML 等どのようなデータも受け入れ可能です。

Q : ゲートウェイ拡張機能でできることは何ですか?

A : 下記のことができます。

  • Java プログラムにより、業務システムや DB サーバと連携することができ、API の機能を拡張することができます。
  • 当社から提供する「.paas.cloud.global.fujitsu.com」ドメインではなく、お客様独自のドメイン名を利用できます(URL を変更することなく API を利用できます)。
    また、任意のポート番号を使用して独自ドメインで API を公開できます(DNS サーバへの CNAME の設定が必要です)。
  • 公開 API に対してアクセス元 IP アドレスを制限することができます。
Q : バックエンドセキュア接続機能では、どのようなバックエンドに接続することができますか?

A : お客様が別途契約している環境上に構築された、DMZ に配備できないバックエンドサービスのデータソースに接続できます。バックエンドサービス接続形態として下記の 2 つの方法があります。

  • FUJITSU Hybrid IT Service FJcloud-O Digital enhanced EXchange によるバックエンドセキュア接続
    FUJITSU Hybrid IT Service FJcloud-O Digital enhanced EXchange を利用して接続する方法です。

    別途 Digital enhanced EXchange の申込が必要です。 Digital enhanced EXchange の詳細については、「Digital enhanced EXchange 」紹介ページをご参照ください。
  • https://jp.fujitsu.com/solutions/cloud/fjcloud/-o/function/paas/private-connect/

    ※Digital enhanced EXchange 提供メニューのうち、下記に対応しています。
    • (1) Digital enhanced EXchange 機能
      • a. 構内接続(100Mbps ベストエフォート(東日本リージョン 1)のみ)
      • b. データセンターアウトソーシング環境接続

  • IPsecVPN 機能によるバックエンドセキュア接続
    FUJITSU Hybrid IT Service FJcloud-O IaaS の IPsec VPN 機能を利用して接続する方法です。

    IPsec VPN 機能の詳細については、「FUJITSU Hybrid IT Service FJcloud-O IaaS 機能説明書」(下記) の「VPN (IPsec VPN)」をご参照ください。
    https://doc.cloud.global.fujitsu.com/lib/iaas/jp/function-manual/index.html

    本サービスとの接続にはネットワーク機器の設定が必要となりますので、事前にヘルプデスクまでご連絡ください。

Q : アナリティクスサービスにおける Pro と Standard の違いは何ですか?

A : Pro は下記の解析パターンを利用できます。

  • Target Performance
  • Cache Performance
  • Error Analysis
  • Developer Engagement
上記の解析パターンで生成される詳細データを保持する期間は 3 か月です。 なお、アナリティクスデータ保持期間を過ぎた詳細データは削除されます。
Q : アナリティクスサービスにおける詳細データはどのようなライフサイクルですか?

A : 下記の通りです。

  • 詳細データの生成
    API コール時に生成されます。

  • 詳細データの保持
    生成された詳細データを下記の時点で保持を開始します。
    • お申込み時に通知された利用開始日

  • 詳細データの参照
    保持された時点で利用者が参照できます。

  • 詳細データの削除
    下記のいずれかの時点で削除されます。
    • アナリティクスデータ保持期限を過ぎた時点
    • プランを解約した時点
Q : アナリティクスデータ保持期間を過ぎて削除されたアナリティクスの詳細データを復旧できますか?

A : 復旧できません。
アナリティクスデータ保持期間内にアナリティクスサービスのデータの取得の WebAPI を使用して詳細データを取得しておくことを推奨します。

Q : WebAPI 機能でできることは何ですか?

A : API Management が提供する API で利用者が下記を実行できます。

  • SSL 証明書の一覧取得、アップロード、エクスポート(ゲートウェイ拡張機能およびバックエンドセキュア接続機能)
  • アナリティクスサービスのデータの取得(API、開発者、開発者アプリに関する統計情報の取得)
    ※GUI で参照は可能ですが、WebAPI を使用することで効率的な分析が可能です。
使用可能な WebAPI については「WebAPIリファレンス」(下記) をご確認ください。
https://apimng.jp-east-1.paas.cloud.global.fujitsu.com/docs/WebAPI-Reference.pdf
Q : DNS オプションでできることは何ですか?

A : バックエンドセキュア接続構成において、プライベート IP アドレスによる通信時の名前解決機能を提供します。
プライベートネットワークに対して API を公開する構成において、API 呼び出し時の名前解決を行います。
また、API Management からプライベートネットワークのバックエンドサービス(システム)やインターネット上のバックエンドサービス(システム)に接続する際の名前解決を行います。

Q : DNS オプションで利用できるドメインは何ですか?

A : API Management サービスの標準ドメインまたはお客様指定のドメインが利用できます。

ご利用方法

Q : 「Unknown username and password combination.」エラーになりログインできません。どうすればよいですか?

A : 下記のいずれかのケースに該当するためエラーになっています。それぞれの対処を実施して再度ログインしてみてください。

  • パスワードが誤っている
    → 正しいパスワードを入力して下さい

  • パスワードの連続誤りによりパスワードがロックされている
    → 15 分経過するとロックが解除されます

  • パスワードの有効期限が切れている
    → ログイン画面上にある「Forgot your password」からパスワードの再発行を行って下さい
Q : API Management にアクセスする際のブラウザの要件を教えてください。

A : 「API Management 動作環境」(下記) をご参照ください。

https://apimng.jp-east-1.paas.cloud.global.fujitsu.com/docs/requirements.html
Q : 接続可能なSSL/TLSバージョンは何ですか?

A : 管理コンソールおよびAPI Proxyへは、TLS1.2のみ接続可能になっております。

Q : バックエンドの前にロードバランサーが存在する場合、API Proxy経由でアクセスすると稀に "502 Bad Gataway" のエラーが返ることがあります。対策方法はありますか?

A : API Management とロードバランサーの Keep-Alive (接続保持) 時間の相違により発生します。 ロードバランサーの Keep-Alive の設定を無効、または 60秒未満に設定してください。

Q : Quota ポリシーを使ってリクエスト数を制限しましたが、制限値を超えてもリクエストが正常に処理されます。

A : API Management のゲートウェイは冗長化されており、デフォルトの設定ではそれぞれのゲートウェイで制限値がカウントされます。すべてのゲートウェイでカウンターを共通化するためには、Quota ポリシーを下記のように設定します。

<Distributed>true<⁄Distributed>

Q : 基本構成を利用しています。API Proxy を作成し、ブラウザから HTTP プロトコルでアクセスすると、エラーが表示されます。

A : セキュリティ対策のため、代表的なブラウザの最新のバージョンでは 10080 ポートへのアクセスを遮断しています。HTTP プロトコルでのアクセスは通信内容が暗号化されずセキュリティ的に脆弱なため、HTTPS プロトコル (ポート 10443) でのアクセスをご利用ください。

契約 ・ 課金

Q : API Management にはどのような契約プランがありますか?

A : 「API Management Service ご紹介資料」(下記) の「API Management Serviceサービスメニュー」の東日本リージョン1をご参照ください。

https://www.fujitsu.com/jp/services/hybrid-it-service/digital-application-platform/dap-api-management-function-overview.pdf
Q : 現在契約中のプランを確認する方法はありますか?

A : FUJITSU Hybrid IT Service ポータルの「ご利用サービス管理」からご確認いただけます。

Q : プランによる違いは何ですか?

A : 固定料金内で利用可能な API コール数および集計期間に違いがあります。また、Analytics サービスにおける詳細データの保持期間(アナリティクスデータ保持期間)や機能に違いがあります。

  • API コール数上限とアナリティクスデータ保持期間
  • プラン名 API コール数上限/
    集計期間
    API コール数
    超過発生時の
    計算単位
    アナリティクスデータ
    保持期間
    Pro
    2500 万/3 か月
    250 万
    3 か月
    3M
    300 万/1 か月
    100 万
    保持しない
    10M
    1000 万/1 か月
    保持しない
    20M
    2000 万/1 か月
    保持しない

  • Analytics データ表示
  • 解析パターン
    Pro
    Standard
    Proxy Performance


    Target Performance


    Cache Performance

       × ※2
    Latency Analysis


    Error Analysis


    Developer Engagement

       × ※2
    Traffic Composition


    Business Transactions ※1
    ×
    ×
    Devices


    Custom Reports

       × ※2
    ※1 将来削除される機能で、現在使用できません。 ○:利用可能 ×:利用不可
    ※2 データが表示される場合がありますが、データの内容は保証されません。
Q : 契約プランの変更は可能ですか?

A : API Management Pro、API Management Standard間の契約変更は不可能です。
API Management Standard契約内のプラン変更は下記の通り可能です。

変更種別
変更方法
変更タイミング
API Management Standard 契約内でのプラン変更
※3M、10M、20M 間のプラン変更
FUJITSU Hybrid IT Service ポータル上でプラン変更可能。
  • 無償トライアル期間中のプラン変更
    → FUJITSU Hybrid IT Service ポータル上でプラン変更を行った日の翌日
  • 有償期間(無償トライアル期間後)中のプラン変更
    → FUJITSU Hybrid IT Service ポータル上でプラン変更を行った日の翌月

詳細は、「API Management Service ご紹介資料」(下記) の「プラン変更の可否」、および「プラン変更方法」をご参照ください。
https://www.fujitsu.com/jp/services/hybrid-it-service/digital-application-platform/dap-api-management-function-overview.pdf
Q : ゲートウェイ拡張機能とバックエンドセキュア接続機能の両方を利用できる契約プランはありますか?

A : バックエンドセキュア接続構成 (下記のいずれか) をご利用中のお客様は、ゲートウェイ拡張構成の機能もご利用いただけます。

  • バックエンドセキュア接続構成 固定メニュー(Pro)
  • バックエンドセキュア接続構成 固定メニュー(3M)
  • バックエンドセキュア接続構成 固定メニュー(10M)
  • バックエンドセキュア接続構成 固定メニュー(20M)
Q : WebAPI 機能を利用できるプランはどれですか?

A : いずれのプランでも利用可能です。
ただし、下記の WebAPI はゲートウェイ拡張構成またはバックエンドセキュア接続構成のみで利用できます。

  • SSL 証明書の一覧取得、アップロード、エクスポート
  • Java Callout Policy の追加
Q : 現在、API Management Pro を利用中ですが、アナリティクスデータ保持期間を変更できますか?

A : できません。
データ保持期間は、 3 か月固定です。

Q : 課金状況を確認できますか?

A : 請求額は API のリクエスト数から算出されます。
請求額の算出対象となるリクエスト数は、次の手順により確認頂けます。

12 月 28 日から過去 3 か月(9 月 28 日 9:00 - 12 月 28 日 9:00)のコール数を確認する場合を例にとって説明します。

  1. OTP認証後、Username と Password を入力してログインします。

  2. Dashboard 画面の「Custom」ボタンを押下します。

  3. 過去 3 か月のカレンダーが表示されます。
    ※カレンダーで一度に選択できる期間は最大で 1 か月のため、過去 3 か月分を確認するには 3 回に分けて確認する必要があります


  4. 過去 1 か月分のリクエスト数を確認するために、開始日(11/29)、終了日(12/28)の順に日付をクリックします。
    ※開始日に指定した日の前日からのリクエスト数になるため、11/28 の翌日である 11/29 を指定します


  5. 「TOTAL TRAFFIC」で 11/28 9:00~12/28 9:00 のリクエスト数が確認できます。


  6. 2 か月前(10/28~11/28)、3 か月前(9/28~10/28)の 1 か月分のリクエスト数についても同様に確認して下さい。
    3 か月分の TOTAL TRAFFIC を合算することで、3 か月間の API コール数になります。
    ※カレンダーにて選択した期間が 9 日間に満たない場合、グラフが時刻表記になり、9:00 始まりではなく、0:00 始まりの期間になります。

    日付表記(期間が 9 日以上):11/28 9:00~12/28 9:00
    時刻表記(期間が 9 日未満):12/25 0:00~12/28 23:00

    9 日未満であっても「By Hour」を「By Day」に変更することにより、9:00 始まりの期間にすることができます。
Q : サービス利用停止の申込みをした場合、課金はその時点で停止されますか?

A : 月額の固定料金は、サービス利用停止のお申込みから最大 3 営業日後に停止されます。
サービス利用停止のお申込日から最大 3 営業日までに実行された API は、利用した API リクエスト数に計上されます。その間のリクエストにより、固定料金に含まれる API リクエスト数の上限を超えた場合には、超過オプションが適用され追加料金が発生する可能性があります。
サービス利用停止のお申込み前に、API リクエストを遮断するために全ての API Proxy をアンデプロイして頂くことにより、これを回避できます。

<例>
JST(日本時間)の 2016/6/16 8:00(2016/6/15 23:00 UTC)にサービス利用停止のお申込みがあった場合
  • 固定料金: 6 月分までが課金されます。
  • API リクエスト数: 最大で 6/21 8:59(2016/6/20 23:59 UTC ※6/18 土、6/19 日は休日のため 3 営業日のカウントには含まれない)までのリクエストがカウントされます。
※料金計算は UTC にて行います。つまり、5 月分は JST(日本時間)では「5/1 9:00~6/1 8:59」になります。