API Gatewayを利用して API呼び出し関連のすべての作業を便利に行えます。APIを安定的に実行するための様々な管理機能と、APIの使用状況をリアルタイムで確認できるダッシュボードを提供します。これにより、お客様はより効率的にビジネスに集中できます。
共通の設定
API URL
https://apigateway.apigw.ntruss.com/api/v1
Swagger UIに移動する
リクエストヘッダ
API Gateway APIで共通して使用されるヘッダは次の通りです。
| 項目 | 必須 | 説明 |
|---|---|---|
| Content-Type | Required | リクエスト Body Content Typeを application/jsonに指定(POST) |
| x-ncp-apigw-timestamp | Required | 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したものである。 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす |
| x-ncp-iam-access-key | Required | ポータルまたは Sub Accountから発行された Access Key ID |
| x-ncp-apigw-signature-v2 | Required | Bodyを Access Key IDとマッピングする SecretKeyで暗号化した署名 HMAC暗号化アルゴリズムは、HmacSHA256を使用 |
レスポンスステータスコード
API Gateway APIで共通して使用されるレスポンスステータスコードは次の通りです。
成功
リクエストが成功した場合、返されるコードは次の通りです。
| HTTPステータスコード | メッセージ | 説明 |
|---|---|---|
| 200 | OK | リクエスト成功 |
| 201 | Created | リクエストの結果により新しいリソースが作成される |
| 202 | Accepted | リクエストは受け取ったが、まだ完了していない |
| 204 | No Content | リクエストは成功したが、レスポンスコンテンツがない |
失敗
リクエストが失敗した場合、返されるコードは次の通りです。
| HTTPステータスコード | コード | メッセージ | 説明 |
|---|---|---|---|
| 400 | 100 | Bad Request Exception | HTTPSプロトコルまたは UTF-8エンコードによるリクエストエラー |
| 401 | 200 | Authentication Failed | リクエストしたリソースを使用するための認証情報が提供されていないか、有効ではない |
| 401 | 210 | Permission Denied | リクエストしたリソースに対する権限がない |
| 403 | 230 | Forbidden | リクエストしたリソースに対する権限がない |
| 404 | 300 | Not Found Exception | リクエストされたリソースが見つからない |
| 429 | 400 | Quota Exceeded | API使用制限(Quota)超過 |
| 429 | 410 | Throttle Limited | APIリクエスト速度を超過 |
| 429 | 420 | Rate Limited | APIリクエスト速度を超過 |
| 413 | 430 | Request Entity Too Large | リクエストボディサイズが、サーバが処理可能な限界を超える |
| 415 | 440 | Unsupported Media Type | サポートしないメディアタイプ |
| 503 | 500 | Endpoint Error | エンドポイント接続エラー |
| 504 | 510 | Endpoint Timeout | エンドポイント接続時間の超過 |
| 503 | 520 | Unknown Endpoint Domain | エンドポイントが認識されないか、設定されていない |
| 503 | 530 | Connection Closed By Endpoint | エンドポイントで接続終了 |
| 500 | 900 | Unexpected Error | 予期せぬ状況によりリクエスト処理失敗 |
HTTP/TLSサポートバージョン
API Gateway APIでサポートする HTTP/TLSバージョンは次の通りです。
| プロトコル | サポートバージョン |
|---|---|
| HTTP |
|
| TLS |
|