API FAQ

FUJITSU Cloud Service K5 API Managementとは?
FUJITSU Cloud Service K5のPaaSのひとつとして提供されるWeb APIのGatewayサービスです。
Web APIサービスを提供されているプロバイダ様や、システムにWeb APIのインタフェースを開発予定のお客様に価値をもたらすサービスです。

API Managementは、APIを提供するサービスとそれを利用するクライアントアプリとの間に位置し、APIのGatewayとして機能します。
API Managementは、トラフィック制御、認証、セキュリティ、ペイロード加工などのさまざまな機能を備えています。
API Management経由でAPIを実行することで、APIにそれらの機能を持たせることができるほか、API自体の開発も可能です。
API Managementを利用するメリットは?

下記のようなメリットがあります。
 ✓ コーディングなしで機能を追加できるため、API開発のコストダウンに繋がります。
 ✓ デバッグ機能、デプロイ機能、開発用環境などの開発機能を利用することで、効率的な開発を実現します。
 ✓ APIの詳細な統計をグラフィカルに確認できるため、パフォーマンス改善、エラー検知、利用状況確認に役立ちます。
 ✓ APIのパッケージング機能によりビジネスプランに合わせた柔軟なAPI製品の提供が可能です。

既存のAPIをAPI Managementを介して利用する場合、エンドユーザがアクセスするURLは変わりますか?

当社から提供する「.paas.cloud.global.fujitsu.com」ドメインではなく、お客様独自のドメイン名を利用することにより、URLを変更することなくご利用頂けるケースがあります。

独自ドメイン名の利用をご希望の際には、サポート窓口までご連絡ください。
なお、お客様にて下記の作業が必要になります。

  ✓  DNSサーバへのCNAMEの設定(独自ドメインを当社ドメインに向ける設定)
  ✓ (HTTPSにてAPIをご利用される場合)SSL証明書のご提供

API実行時にHTTPSを利用できますか?
HTTPに加え、HTTPSもご利用いただけます。
APIのペイロードに指定はありますか?

ありません。

API Managementを使用するために、API Managementが指定したデータを、クエリやヘッダー、ボディに追加して頂くことはありません。

APIのペイロードの形式に指定はありますか?

ありません。

JSONやXML等どのようなデータも受け入れ可能です。

API Managementを介することでどの程度の遅延が生じますか?
API ManagementでAPIに追加する機能の数や、処理の重さに依存します。
バックエンドに指定するサービスに制限はありますか?
インターネット経由でアクセスできるHTTPベースのサービスであれば指定可能です。
APIを利用するクライアント向けのSDKはありますか?

クライアント向けSDKは提供しておりません。

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

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

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

トラフィック制御

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

ペイロード加工

   ✓ データ形式の変換
   ✓ リクエスト/レスポンスデータの編集

認証/セキュリティ

   ✓ 0Auth2.0
   ✓ API Key認証
   ✓ IP制限
   ✓ Webフィルタリング

拡張

   ✓ ユーザースクリプト(JavaScript)の実行
   ✓ 複数のバックエンドサービスから受け取ったレスポンスデータのマッシュアップ

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

Analytics機能により以下を確認できます。

   ✓ レスポンス数
   ✓ レスポンス時間
   ✓ キャッシュのヒット率
   ✓ エラー統計
   ✓ リクエストを実行したアプリ毎の統計

API Proxy別やアプリ別での表示、フィルターやドリルダウン機能を備えており、詳細な統計を確認できます。

APIの利用状況に対してアラートを設定できますか?
アラートなどの自動監視機能はございません。
「Unknown username and password combination.」エラーになりログインできません?

本エラーは次のケースにおいて発生します。

   ✓ パスワードが誤っている
      →正しいパスワードを入力して下さい
   ✓ パスワードの連続誤りによりパスワードがロックされている
      →15分経過するとロックが解除されます
   ✓ パスワードの有効期限が切れている
      →ログイン画面上にある「Forgot your password」からパスワードの再発行を行って下さい

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

請求額はAPIのリクエスト数から算出されます。
請求額の算出対象となるリクエスト数は、次の手順により確認頂けます。
12月28日から過去3ヶ月(9月28日 9:00 – 12月28日 9:00)のコール数を確認する場合を例にとって説明します。

1. UsernameとPasswordを入力してログインします。

faq_api_00014a.png



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

faq_api_00014b.png



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

faq_api_00014c.png



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

faq_api_00014d.png



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

faq_api_00014e.png



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始まりの期間にすることができます。

faq_api_00014f.png
サービス利用停止の申込みをした場合、課金はその時点で停止されますか?
月額の固定料金は、サービス利用停止のお申込み時点で停止され、翌月の固定料金は発生しません。

ただし、サービス利用停止のお申込日から最大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」になります。
Pro版とStandard版の違いは何ですか?

固定料金内で利用可能なAPIコール数および集計期間に違いがあります。また、Analyticsサービスの機能に違いがあります。

・APIコール数上限

カタログ名称

APIコール数上限

集計期間

APIコール数

超過発生時の計算単位

Pro

2500万

3ヶ月

250万

Standard 3M

300万

 

1ヶ月

 

100万

Standard 10M

1000万

 Standard 20M

2000万

・Analyticsデータ表示

解析パターン

Pro

Standard

Proxy Performance

Target Performance

×

Cache Performance

Latency Analysis

Error Analysis

Developer Engagement

Traffic Composition

Business Transactions

Devices

Custom Reports

△(*1)

   (*1)一部Metrics, Dimensionのみ表示可能
契約プランの変更は可能ですか?(例、API Management ProからAPI Management Standardへのプラン変更)

可能です。

変更種別

変更方法

変更タイミング

カタログ変更

※API Management Pro、API Management Standard間の契約変更

K5サポート窓口までお問い合わせ下さい。※1

  • 20日までにご連絡いただいた場合 →翌月
  • 21日以降にご連絡いただいた場合→翌々月

API Standard契約内でのプラン変更

※3M、10M、20M間のプラン変更

PaaSポータル上でプラン変更可能。

  • 無償トライアル期間中のプラン変更
    →PaaSポータル上でプラン変更を行った日の翌日
  • 有償期間(無償トライアル期間後)中のプラン変更
    →PaaSポータル上でプラン変更を行った日の翌月


※1 お問い合わせ時には下記の内容を記入願います。

項目

内容

件名

API Managementカタログ変更依頼

お問い合わせ内容

・変更後のサービス名

・変更後サービスの希望開始月

変更後のサービス名: API Management Standard 3M

変更後サービスの希望開始月: 2016/9