登録したAPIのアクセス

登録したAPIへのアクセスは以下のように実施してください。X-Api-Keyヘッダーは、APIキーを使用する場合のみ指定してください。

$ curl https://<LBaaSのIPアドレス>/<APIフロントエンドパス> \
-H 'X-Api-Key: <APIキー>'

例)

$ curl https://<LBaaSのIPアドレス>/581bd924/api1
-H 'X-Api-Key: 62eb165c070a41d5c1b58d9d3d725cal'

APIキー設定登録済みAPIに対し、APIキーが省略された場合は401のエラーを返却します。

HTTP/1.1 401 Unauthorized

APIキー設定登録済みAPIに対し、誤ったAPIキーが指定された場合は403のエラーを返却します。

HTTP/1.1 403 Forbidden

トラフィック制御の制限を超えた場合のレスポンス例を下記に示します。

Spike ArrestでのAPIリクエスト数制限値エラーレスポンス例

HTTP/1.1 429 Too Many Requests
Date: Mon, 15 Oct 2018 04:32:43 GMT
Connection: keep-alive
Content-Length: 17

Too many requests

Concurrent Rate LimitでのAPIリクエスト数制限値エラーレスポンス例

HTTP/1.1 503 Service Temporarily Unavailable
Date: Tue, 16 Oct 2018 05:41:16 GMT
Connection: keep-alive
Content-Length: 60

Service unavailable: ConcurrentRatelimit connection exceeded

注) API Proxyを経由する場合、Host等のHTTPヘッダーが書き換わる可能性があります。

登録したAPIのアクセスを実行してバックエンドのアプリケーションに影響がないことを予め検証することを推奨します。

4.3.5 登録したAPIのアクセス