--- title: "Default Usage Planの設定" slug: "apigateway-stage-putdefaultusageplan" updated: 2026-09-17T09:57:26Z published: 2026-09-17T09:57:26Z canonical: "api.ncloud-docs.com/apigateway-stage-putdefaultusageplan" --- > ## 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. # Default Usage Planの設定 Classic/VPC環境で利用できます。 指定した Stageの Default Usage Planを設定します。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | PUT | /api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/usage-plan | ### リクエストヘッダ API Gatewayで共通して使用されるヘッダの詳細は、[API Gatewayのリクエストヘッダ](/docs/ja/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストパスパラメータ リクエストパスパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `product-id` | String | Required | Stageが属する Product ID - 0~10文字 - [Productリストの照会](/docs/ja/apigateway-product-getproductlist)を参照 | | `api-id` | String | Required | Stageが属する API ID - 0~10文字 - [APIの照会](/docs/ja/apigateway-api-apis)を参照 | | `stage-id` | String | Required | Default Usage Planを設定する対象の Stage ID - 0~10文字 - [Stageリストの照会](/docs/ja/apigateway-stage-getstagelist)を参照 | ### リクエスト構文 リクエスト構文は次の通りです。 ``` { "monthQuotaRequest" : 1, "dayQuotaRequest" : 6, "rateRps" : 0, "quotaCondition" : "quotaCondition" } ``` ### リクエストボディ リクエストボディの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `monthQuotaRequest` | Long | Conditional | 月別リクエスト処理限度(件/月) - 0~9,007,199,254,740,991 - `dayQuotaRequest`入力時、必須 | | `dayQuotaRequest` | Long | Conditional | 日別リクエスト処理限度(件/日) - 0~9,007,199,254,740,991 - `monthQuotaRequest`入力時、必須 | | `rateRps` | Long | Optional | リクエスト処理量(件/秒) - 1~2,147,483,647 | | `quotaCondition` | String | Optional | 使用量制御条件 - `2xx` \| `3xx` \| `4xx` \| `5xx` \| `others` | ### リクエスト例 リクエストのサンプルコードは次の通りです。 ``` curl --location --request PUT 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***fh5o***/usage-plan' \ --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 '{ "monthQuotaRequest" : 1, "dayQuotaRequest" : 6, "quotaCondition": "2xx", "rateRps" : 1 }' ``` ## レスポンス レスポンス形式を説明します。 ### レスポンス構文 レスポンス構文は次の通りです。 ``` { "stage" : { "canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00", "modifier" : "modifier", "canaryEndpointDomain" : "canaryEndpointDomain", "canaryThrottleRps" : 5, "cacheTtlSec" : 0, "stageName" : "stageName", "throttleRps" : 4, "monthQuotaRequest" : 9, "canaryCacheTtlSec" : 6, "canaryDistributionRate" : 5.962134, "apiId" : "apiId", "stageId" : "stageId", "deployedStageDeploymentNo" : 7, "useDistributionRate" : true, "canaryDeploymentDescription" : "canaryDeploymentDescription", "dayQuotaRequest" : 2, "isMaintenance" : true, "rateRps" : 3, "endpointDomain" : "endpointDomain", "ipAclList" : "ipAclList", "canaryDeploymentNo" : 1, "regTime" : "2000-01-23T04:56:07.000+00:00", "response" : "response", "canaryConditions" : [ { "parameterName" : "parameterName", "parameterCode" : "REQUEST_HEADER", "parameterValue" : "parameterValue" } ], "tenantId" : "tenantId", "ipAclCode" : "ALLOWED", "statusCode" : 2, "enabledContentEncoding": true, "minimumCompressionSize": 0 } } ``` ### レスポンスステータスコード 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)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 ``` { "stage": { "tenantId": "***e230cebc1402ba89b148896951***", "modifier": "***d3020-5bb7-11ec-bfb8-246e96591***", "stageId": "***fh5o***", "apiId": "***51hs***", "stageName": "stage000", "endpointDomain": "https://test***.test.com", "rateRps": 1, "dayQuotaRequest": 6, "monthQuotaRequest": 1, "deployedStageDeploymentNo": 250***, "regTime": "2024-05-07T23:48:47Z", "isMaintenance": false, "enabledContentEncoding": false } } ```