getQuota

Prev Next

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

ユーザーが設定した GeoLocation APIの呼び出し限度タイプと月間最大呼び出し件数を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /quota

リクエストヘッダ

GeoLocation APIで共通して使用されるヘッダの詳細は、GeoLocationのリクエストヘッダをご参照ください。

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
resource.type String Required 限度タイプ
  • Unlimited | Limited
    • Unlimited: 利用無制限
    • Limited: 利用制限
resource.quota Integer Required 設定された月間最大呼び出し件数
  • 限度がUnlimitedの場合、-1を返す

レスポンスステータスコード

GeoLocation APIで共通して使用されるレスポンスステータスコードの詳細は、GeoLocationのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

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