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 information about the headers common to all 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
resource.type String Required Limit type
  • Unlimited | Limited
    • Unlimited: usage unlimited
    • Limited: usage limited
resource.quota Integer Required Set maximum number of calls per month
  • Return -1 if the limit is Unlimited

Response status codes

For information about the HTTP status codes common to all GeoLocation APIs, see GeoLocation response status codes.

Response example

The following is a sample response.

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