---
title: "Usage Planリストの照会"
slug: "apigateway-usageplan-getusageplanlist"
updated: 2026-09-17T09:57:26Z
published: 2026-09-17T09:57:26Z
canonical: "api.ncloud-docs.com/apigateway-usageplan-getusageplanlist"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage Planリストの照会

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

ユーザーが指定した条件を満たす Usage Planリストを照会します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| POST | /api/v1/usage-plans/search |

### リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、[API Gatewayのリクエストヘッダ](/docs/ja/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエスト構文

リクエスト構文は次の通りです。

```
{
    "offset" : 6,
    "limit" : 0,
    "usagePlanName" : "usagePlanName"
}
```

### リクエストボディ

リクエストボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `offset` | Long | Optional | レスポンスデータの開始点 - 0~9,223,372,036,854,775,807 - `limit`と共にページネーションの実装に使用 |
| `limit` | Long | Optional | レスポンスデータの最大数 - 1~9,223,372,036,854,775,807 - `offset`と共にページネーションの実装に使用 |
| `usagePlanName` | String | Optional | 照会対象の Usage Planの名前 - 0~45文字 |

### リクエスト例

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

```
curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/usage-plans/search' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "usagePlanName" : "usageplan001"
}'
```

## レスポンス

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

### レスポンス構文

レスポンス構文は次の通りです。

```
{
    "initialCount" : 0,
    "total" : 6,
    "usagePlans" : [ {
        "domainCode" : "domainCode",
        "usagePlanId" : "usagePlanId",
        "modifier" : "modifier",
        "associatedStagesCount" : 0,
        "dayQuotaRequest" : 6,
        "permission" : "permission",
        "rateRps" : 5,
        "usagePlanName" : "usagePlanName",
        "monthQuotaRequest" : 1,
        "tenantId" : "tenantId",
        "disabled" : true,
        "usagePlanDescription" : "usagePlanDescription",
        "quotaCondition" : "quotaCondition",
        "actionName" : "actionName"
  } ]
}
```

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

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、[API Gatewayのレスポンスステータスコード](/docs/ja/ai-application-service-apigateway#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

```
{
    "usagePlans": [
        {
            "tenantId": "***e230cebc1402ba89b148896951***",
            "usagePlanId": "***xogj***",
            "usagePlanName": "usageplan001",
            "domainCode": "PUB",
            "associatedStagesCount": 0
        }
    ],
    "total": 1,
    "initialCount": 2
}
```