Edit usage plan
- Print
- PDF
Edit usage plan
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Edit usage plan information according to the user-defined conditions.Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| PUT | /usage-plans/{usage-plan-id} |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
usage-plan-id | String | Required | ID of usage plan to edit
|
Request syntax
The request syntax is as follows.
{
"monthQuotaRequest" : 6,
"dayQuotaRequest" : 0,
"usagePlanDescription" : "usagePlanDescription",
"rateRps" : 1,
"quotaCondition" : "quotaCondition",
"usagePlanName" : "usagePlanName"
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
monthQuotaRequest | Long | Conditional | Monthly request processing limit (cases/month) to edit to
|
dayQuotaRequest | Long | Conditional | Daily request processing limit (cases/day) to edit to
|
usagePlanDescription | String | Optional | Description for the usage plan to edit to
|
rateRps | Long | Optional | Request throughput (cases/second) to edit to
|
quotaCondition | String | Optional | Usage control conditions to edit to
|
usagePlanName | String | Required | Name of usage plan to edit to
|
Request example
The following is a sample request.
curl --location --request PUT 'https://apigateway.apigw.ntruss.com/api/v1/usage-plans/***wthl***' \
--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": 15,
"dayQuotaRequest": 10,
"rateRps": 5,
"quotaCondition": "2xx",
"usagePlanDescription": "usageplan000",
"usagePlanName": "usageplan000"
}'
Response
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"usagePlan" : {
"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"
}
}
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.
Response example
The following is a sample response.
{
"usagePlan": {
"tenantId": "***e230cebc1402ba89b148896951***",
"usagePlanId": "***wthl***",
"rateRps": 5,
"usagePlanName": "usageplan000",
"usagePlanDescription": "usageplan000",
"dayQuotaRequest": 10,
"quotaCondition" : "2xx",
"monthQuotaRequest": 15,
"domainCode": "PUB",
"associatedStagesCount": 0
}
}
Was this article helpful?