API Gateway overview
- Print
- PDF
API Gateway overview
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
API Gateway makes it easy to do everything related to API calls. Various management features for stable execution of APIs and a dashboard for viewing the API usage status in real time can be used. This allows you to focus on your business more efficiently.
Common attributes
API URL
https://apigateway.apigw.ntruss.com/api/v1
Go to Swagger UI
Request headers
The following headers are commonly used by the API Gateway API.
| Category | Requirement Status | Description |
|---|---|---|
| Content-Type | Required | Specify the request body content type as application/json (POST) |
| x-ncp-apigw-timestamp | Required | It indicates the time elapsed since January 1, 1970 00:00:00 (UTC) in milliseconds. Request is considered invalid if the timestamp differs from the current time by more than 5 minutes |
| x-ncp-iam-access-key | Required | This is the access key ID issued by the portal or Sub Account. |
| x-ncp-apigw-signature-v2 | Required | Signature that encrypts the body with secret key mapped to the access key ID Use the HMAC-SHA256 encryption algorithm |
Response status codes
The following are commonly used response status codes in API Gateway API.
Succeeded
The following codes are returned if the request is successful.
| HTTP status code | Message | Description |
|---|---|---|
| 200 | OK | Request succeeded |
| 201 | Created | A new resource is created as a result of the request |
| 202 | Accepted | The request has been accepted but not yet completed |
| 204 | No Content | The request succeeded, but no response content |
Failure
The following codes are returned if the request fails.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| 400 | 100 | Bad Request Exception | Request error due to HTTPS protocol or UTF-8 encoding |
| 401 | 200 | Authentication Failed | Authentication information to use the requested resource was not provided or is invalid |
| 401 | 210 | Permission Denied | No permissions to the requested resource |
| 403 | 230 | Forbidden | No permissions to the requested resource |
| 404 | 300 | Not Found Exception | Requested resource not found |
| 429 | 400 | Quota Exceeded | Exceeded API usage limit (quota) |
| 429 | 410 | Throttle Limited | Exceeded API request rate |
| 429 | 420 | Rate Limited | Exceeded API request rate |
| 413 | 430 | Request Entity Too Large | Request body size exceeds the limit the server can handle |
| 415 | 440 | Unsupported Media Type | Unsupported media type |
| 503 | 500 | Endpoint Error | Endpoint connection error |
| 504 | 510 | Endpoint Timeout | Endpoint connection time limit exceeded |
| 503 | 520 | Unknown Endpoint Domain | Endpoint not recognized or not set up |
| 503 | 530 | Connection Closed By Endpoint | Disconnection from the endpoint |
| 500 | 900 | Unexpected Error | Failed to process request due to unexpected circumstances |
Supported HTTP/TLS version
The HTTP/TLS versions supported by API Gateway API are as follows.
| Protocol | Supported version |
|---|---|
| HTTP |
|
| TLS |
|
Go to NAVER Cloud Platform authentication key and signature creation guide
Web console
Was this article helpful?