一般的な問題

Classic/VPC環境で利用できます。

API Gatewayサービスの利用中に次のような問題が発生することがあります。問題ごとの原因と解決方法を確認し、適切に対処してください。

API呼び出しエラー

IAM認証を使用して APIを呼び出す場合、正常に呼び出されないことがあります。

原因

ユーザーのタスク環境によって様々な原因が考えられます。

• シグネチャー値作成 時に不正な URLを使用しています。
• 呼び出す APIと Signature key作成時に使用するメソッドが異なります。
• シグネチャー値の作成時に不正な timestampを使用しています。
• クライアントサーバのサーバ時間が合いません。
• accessKey値が無効です。

解決方法

シグネチャー作成時に不正な URLを使用
シグネチャー作成時にドメインを除いた pathとすべてのクエリ文字列を使用してください。呼び出す APIが https://uh7m0wgsis.apigw.ntruss.com/photos/puppy.jpg?query1=&query2の場合、シグネチャー作成に使用する URLは /photos/puppy.jpg?query1=&query2 です。

呼び出す APIとシグネチャー作成時に使用するメソッドが異なる
正常に呼び出すには、呼び出す APIとシグネチャー作成時に使用するメソッドが同じである必要があります。呼び出す APIとシグネチャー作成時に使用するメソッドが同じか確認します。

シグネチャー作成時に不正な timestampを使用

• header(x-ncp-apigw-timestamp)とシグネチャー作成時に同じ timestamp値を使用する必要があります。呼び出しに失敗した場合、headerとシグネチャーの timestamp値を別途取得していないか確認します。
• timestamp値の取得後、更新せず使用していないか確認します。
• API Gatewayサーバとの時間差が5以上の場合、無効な timestamp値として判断します。timestamp値を取得した後に更新せず使用する場合、最初の何回呼び出し後にエラーが発生するため、断続的に発生する問題のように見える場合があります。API呼び出し時に timestamp値を新たに作成します。

クライアントのサーバ時間が合わない場合
クライアントのサーバ時間が合わない場合、API Gatewayで無効な timestamp値と判断して正常に呼び出せない場合があります。クライアントサーバ時間が正確か確認します。

accessKey値が無効な場合
accessKey値が無効な場合、IAM認証エラーが発生する場合があります。API呼び出し時に有効な accessKeyを使用します。

API Key復旧

削除した API Keyを復旧できません。

原因

削除した API Keyは復旧できません。

解決方法

削除した API Keyは復旧できないので、使用中の API Keyを削除しないようにご注意ください。

CORSエラー

CORSエラーが発生します。

原因

CORS設定が完了しない場合、エラーが発生することがあります。

解決方法

API Gatewayリソースの CORS設定を完了してください。詳細は、リソースの CORS設定をご参照ください。

Endpointで VPC内のプライベート IPアドレスを指定不可

API Gatewayで処理する Endpointの中から HTTP(S)の URLを内部 VPCとして指定しようとすると、指定されません。

原因

API Gatewayの Endpointで VPC内のプライベート IPアドレスを指定できません。

解決方法

• パブリック IPアドレスまたは外部からアクセス可能なドメインを指定してください。
• Public Load Balancerなどを使用して外部からアクセスできるように設定した後、その Endpointを連携します。