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 ゲートウェイ拡張構成」をご利用いただきますと、標準提供のドメインではなく、 お客様独自のドメイン名を利用することにより、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 : アナリティクスサービスにより、レスポンス件数や時間、キャッシュヒット率、アプリ毎のリクエスト実行統計、エラー統計、などAPIの利用状況を確認できます。
また、統計情報取得用 WebAPI を利用すれば、利用状況をダウンロードすることもできます。

アナリティクスサービスでは以下の解析パターンを提供しています。
ただし、解析パターンによっては、別途、フルアナリティクスオプションのご契約が必要です。

解析パターン 解析詳細 利用可否
※1
Proxy Performance API Proxyのトラフィック量と平均応答時間をグラフ化
Target Performance 全バックエンドサービスへのトラフィック量とリクエストの成功・失敗件数、応答時間、レスポンスの 成功・失敗件数、ペイロードサイズをグラフ化
Cache Performance トラフィック制御ポリシーを通じて処理されたキャッシュヒット率や件数、応答時間をグラフ化
Latency Analysis API Proxyの応答時間や、バックエンドサービスの応答時間をグラフ化
Error Analysis API Proxyが処理するリクエストおよびレスポンスで発生したエラーの情報(件数やステータス コード等)をグラフ化
Developer Engagement Developerの人数、アクセス状況、トラフィック量、エラー率をグラフ化
Traffic Composition API Proxy、API Product、Developer、アプリケーションのトラフィック量Top10をグラフ化
Devices API Proxyに対するアクセス元のデバイス情報 (プラットフォーム、エージェント、デバイスタイプ、 OS種別等)をグラフ化
Custom Reports 縦軸、横軸、ならびに統計期間を所定の項目から自由に選択して情報をグラフ化
※1 〇:利用可能 △:フルアナリティクスオプションで利用可能
機能

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

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

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

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

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

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

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

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

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

  • Java プログラムにより、業務システムや DB サーバと連携することができ、API の機能を拡張することができます。
  • 標準提供のドメインではなく、お客様独自のドメイン名を利用できます(URL を変更することなく API を利用できます)。
  • 公開 API に対してアクセス元 IP アドレスを制限することができます。
Q : バックエンドセキュア接続構成では、どのようなバックエンドに接続することができますか?

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

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

    別途 FUJITSU Hybrid IT Service FJcloud-O Digital enhanced EXchange の申込が必要です。 FUJITSU Hybrid IT Service FJcloud-O Digital enhanced EXchange サービスの詳細については、「FUJITSU Hybrid IT Service FJcloud-O Digital enhanced EXchange 利用ガイド」をご参照ください。
  • Digital enhanced EXchange利用ガイド

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

      その他の接続形態(オンプレミス接続、他社クラウド接続など)につきましては、ヘルプデスクまでお問い合わせください。

  • FUJITSU Hybrid IT Service FJcloud-O ネットワーク RBAC (Role-Based Access Control) によるバックエンドセキュア接続構成
    FUJITSU Hybrid IT Service FJcloud-O ネットワーク RBAC を利用して接続する方法です。

    ネットワーク RBAC 機能の詳細については、「FUJITSU Hybrid IT Service FJcloud-O IaaS 機能説明書」(下記) の「ネットワークRBAC」をご参照ください。
  • IaaS 機能説明書 ネットワーク RBAC (Role-Based Access Control)

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

    IPsec VPN 機能の詳細については、「FUJITSU Hybrid IT Service FJcloud-O IaaS 機能説明書」(下記) の「IPsecVPN 機能」をご参照ください。
    IPsecVPN 機能

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

Q : アナリティクスサービスにおけるフルアナリティクス機能でできることは何ですか?

A : 下記の解析パターンを利用できます。
これらの機能を利用するためには、別途、フルアナリティクスオプションのご契約が必要です。

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

A : 下記の通りです。

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

  • 詳細データの保持
    フルアナリティクスオプション利用開始通知書に記載された利用開始日から詳細データを保持します。

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

  • 詳細データの削除
    下記のいずれかの時点で削除されます。
    • 詳細データ保持期限(3 か月)を過ぎた時点
    • フルアナリティクスオプションの利用終了日を過ぎた時点
    • API Management を解約した時点
Q : アナリティクスデータ保持期間を過ぎて削除されたアナリティクスの詳細データを復旧できますか?

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

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

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

  • SSL 証明書の一覧取得、アップロード、エクスポート(ゲートウェイ拡張構成およびバックエンドセキュア接続構成)
  • アナリティクスサービスのデータの取得(API、開発者、開発者アプリに関する統計情報の取得)
    ※管理コンソールで参照は可能ですが、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 サービスの標準ドメインまたはお客様指定のドメインが利用できます。
DNS オプション提供にあたり、お客様指定のドメイン利用やお客様の DNS との接続について事前に確認するため、お申込み前にヘルプデスクにお問い合わせください。お申込み後、約 10 営業日でご利用いただけます。

Q : 企業独自のドメイン (例: 企業名.co.jp) を利用できますか?

A : ゲートウェイ拡張構成またはバックエンドセキュア接続構成をご契約いただければ、お客様のドメインおよびサーバ証明書を利用できます。

Q : バックエンドセキュア接続構成を利用して、企業内ネットワークに設置されるバックエンドサーバに接続する際のネットワーク要件はありますか?

A : 172.23.0.0/16 のネットワークアドレス (CIDR) をご利用の場合は直接接続することができません。利用する場合は NAT(Network Address Transfer) による IP アドレスの変換をお願いいたします。

Q : MessageLogging ポリシーによるメッセージの出力先には syslog とローカルディスクを設定できるようですが、どちらも利用できますか?

A : 出力先には syslog のみ設定可能です。ファイル出力はご利用いただけません。

ご利用方法

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

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

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

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

  • パスワードの有効期限が切れている
    → ログイン画面上にある「Forgot your password」からパスワードの再発行を行って下さい
Q : すぐに利用開始することはできますか?

A : お申込みプランまたはオプションによって、ご利用いただけるまでの日数が異なります。

  • 基本構成の場合
    FUJITSU Cloud Service ポータルのサービス利用設定申込画面から利用申込をしていただいてから、約 3 営業日でご利用いただけます。

  • ゲートウェイ拡張構成の場合
    FUJITSU Cloud Service ポータルのサービス利用設定申込画面から利用申込をしていただいてから、約 10 営業日でご利用いただけます。

  • バックエンドセキュア接続構成の場合
    バックエンドと接続する回線情報確認のため、お申込み前にヘルプデスクにお問い合わせください。
    IPsecVPN接続をご利用の場合は、回線開通確認後、約 10 営業日でご利用いただけます。
    Digital enhanced EXchange の場合は、お客様のネットワーク環境などによりご利用いただけるまでの日数が変わります。

  • DNSオプションの場合
    ドメインやお客様の内部DNSとの接続情報確認のため、お申込み前にヘルプデスクにお問い合わせください。確認後に利用申込していただいてから、約 10 営業日でご利用いただけます。バックエンドセキュア接続構成の利用開始日以降に利用申込いただく必要があります。
Q : API Management にアクセスする際のブラウザの要件を教えてください。

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

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

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

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

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

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

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

<Distributed>true<⁄Distributed>

Q : Java Callout ポリシーで、組織または環境配下に対して Java リソースを配備して利用する際、同じクラス名のリソースを複数配備することはできますか?

A : クラス名(パッケージ+クラス)が重複する場合は正しく動作しません。必ずクラス名が一意になるように配備してください。

Q : 組織のユーザを追加する場合、姓名には日本語(全角文字)が利用できますか?

A : 姓名は半角英数字を設定してください。全角文字を入力した場合、文字化けなど誤動作する場合があります。

Q : パスワード設定画面に "Passwords must have a Good or Strong rating. Passwords must be at least 8 characters long." と記載されていますが、実際には 16 文字以上を設定しないとエラーになります。

A : メッセージに誤りがありますが、パスワードは 16 文字以上にしていただくようお願いいたします。

Q : 管理コンソールに接続する方法を教えてください。

A : 2022年4月1日より、セキュリティ強化のため管理コンソールに接続するためには2段階の認証が必要になりました。

  • 2022年3月31日以前にご利用開始のお客様
    2022年3月にFUJITSU Hybrid IT Service FJcloud-Oの「利用責任者」宛てにお送りしました「認証強化に伴う設定追加について」の表題のメールを参照いただき、ワンタイムパスワード認証の設定をお願いいたします。

  • 2022年4月1日以降にご利用開始のお客様
    ご利用開始前にお送りしました「OTP認証導入手順書」および「サービス利用開始通知書」を参照いただき、ワンタイムパスワード認証の設定をお願いいたします。
    管理コンソールへログインするためのOTP認証アカウントの追加登録につきましては、FUJITSU Hybrid IT Service FJcloud-Oの「利用責任者」の方からヘルプデスク宛てに下記の情報を添えてご依頼ください。

    • 契約番号
    • 登録を希望するメールアドレス

    ヘルプデスクにて登録後、アカウント情報(認証セットアップURL/ID/パスワード)を「利用責任者」のアドレスに送付します。
Q : API Proxy のサンプルは提供されていますか?

A : API Managementでは、Google社のApigee Edgeを採用しております。
下記の Google 社のリンクをご参照ください。

上記リンクに対しては、ヘルプデスクでサポートできかねます。ご了承ください。
Q : 作成したAPI Proxyに対し、ブラウザからHTTP プロトコルでアクセスしようとすると、勝手にHTTPS プロトコルに変更されてしまいます。

A : セキュリティ対策のため、代表的なブラウザの最新のバージョンでは HTTP プロトコルをHTTPS プロトコルに変更するよう設定されている場合があります。 HTTP プロトコルでのアクセスは通信内容が暗号化されずセキュリティ的に脆弱なため、HTTPS プロトコル でのアクセスをご利用ください。

契約 ・ 課金

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

A : 下記の契約プランを提供しています。

プラン名 課金単位 備考 ※1
基本構成 固定メニュー(3M) API呼出回数(1か月ごとに集計)
固定(固定メニュー)+従量(オプション)
  • 固定メニュー(3M):300万コール/1か月
  • 固定メニュー(10M):1000万コール/1か月
  • 固定メニュー(20M):2000万コール/1か月
  • 超過オプション:100万コール毎
固定メニュー(10M)
固定メニュー(20M)
ゲートウェイ拡張構成 固定メニュー(3M)
固定メニュー(10M)
固定メニュー(20M)
バックエンドセキュア
接続構成
固定メニュー(3M)
固定メニュー(10M)
固定メニュー(20M)
Q : 現在契約中のプランを確認する方法はありますか?

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

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

A : 固定メニュー内で利用可能な API コール数に違いがあります。

プラン名 API コール数上限/集計期間 API コール数超過発生時の
計算単位
固定メニュー (3M) 300 万/1 か月 100 万
固定メニュー(10M) 1000 万/1 か月
固定メニュー(20M) 2000 万/1 か月
Q : 契約プランの変更は可能ですか?(例 : 基本構成 固定メニュー(3M) から 基本構成 固定メニュー(10M) へのプラン変更)

A : 同一構成(基本構成、ゲートウェイ拡張構成、バックエンドセキュア接続構成)内でのプラン変更は可能です。

変更種別
変更方法
変更タイミング
同一構成内での固定メニュー間(3M, 10M, 20M)のプラン変更 FUJITSU Cloud Service ポータル上でプラン変更可能。
  • 無償トライアル期間中のプラン変更
    → FUJITSU Cloud Service ポータル上でプラン変更を行った日の翌日
  • 有償期間(無償トライアル期間後)中のプラン変更
    → FUJITSU Cloud Service ポータル上でプラン変更を行った日の翌月

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

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

  • バックエンドセキュア接続構成 固定メニュー(3M)
  • バックエンドセキュア接続構成 固定メニュー(10M)
  • バックエンドセキュア接続構成 固定メニュー(20M)
Q : API Management契約途中でフルアナリティクスオプションを追加しても、オプション追加前のアナリティクスデータを参照できますか?

A : 参照できません。
参照できることもありますがデータの保証はしていません。
オプション追加前にアナリティクスサービスのデータ取得 WebAPI を使用して詳細データを取得しておくことを推奨します。

Q : フルアナリティクスオプション利用時にプランを変更(APIコール数の変更)しても参照できますか?

A : 継続して詳細データを参照できます。

Q : フルアナリティクスオプションを解約した場合、詳細データは保持されますか?

A : フルアナリティクスオプションご利用時に保持されていた詳細データはフルアナリティクスオプション解約時に削除されますので、 オプション解約後は詳細データを参照できません。
フルアナリティクスオプションを解約する前にアナリティクスサービスのデータ取得 WebAPI を使用して詳細データを取得しておくことを推奨します。

Q : WebAPI 機能を利用できるプランはどれですか?

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

  • SSL 証明書の一覧取得、アップロード、エクスポート
  • Java Callout Policy の追加
Q : 現在フルアナリティクスオプションを利用中ですが、アナリティクスデータ保持期間を延長することができますか?

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

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」になります。