getQuota

Prev Next

Available in Classic and VPC

Get the GeoLocation API call limit type and maximum number of calls per month set by the user.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET /quota

Request headers

For headers common to GeoLocation APIs, see GeoLocation request headers.

Request example

The following is a sample request.

curl --location --request GET 'https://geolocation.apigw.ntruss.com/geolocation/v2/quota'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Required Description
type String Required Limit type
  • Unlimited | Limited
    • Unlimited: usage unlimited
    • Limited: usage limited
quota Integer Required Set maximum number of calls per month
  • Return -1 if the limit is Unlimited

Response status codes

The following describes the response status codes. For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

HTTP status code Code Message Description
204 - OK (No Content) Request succeeded
400 131001 Invalid Quota Invalid limit settings
400 131002 Internal Server Error GeoLocation server error
  • Solution: Try again after a while, or contact Support if the issue persists
400 131004 Subscription Required GeoLocation service subscription required
  • Solution: Subscribe to the GeoLocation service from the Services > Application Services > GeoLocation > Subscription menu of the NAVER Cloud Platform console
404 - Not Found Resource not found
500 - Internal Server Error Internal server error

Response example

The following is a sample response.

{
    "resource": {
        "type": "Limited",
        "quota": 100
    }
}