Create usage plan

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Create a usage plan according to the user-defined conditions.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
POST	/usage-plans

Request headers

For headers common to API Gateway, see API Gateway common request headers.

Request syntax

The request syntax is as follows.

{
    "monthQuotaRequest" : 1,
    "dayQuotaRequest" : 6,
    "usagePlanDescription" : "usagePlanDescription",
    "rateRps" : 0,
    "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) 0 - 9,223,372,036,854,775,807 Required when entering `dayQuotaRequest`
`dayQuotaRequest`	Long	Conditional	Daily request processing limit (cases/day) 1 - 9,223,372,036,854,775,807 Required when entering `monthQuotaRequest`
`usagePlanDescription`	String	Optional	Description for the usage plan to create 0 - 50 characters
`rateRps`	Long	Optional	Request throughput (cases/second) 1 - 2,147,483,647
`quotaCondition`	String	Optional	Usage control conditions `2xx` \| `3xx` \| `4xx` \| `5xx` \| `others`
`usagePlanName`	String	Required	Name of usage plan to create 0 - 45 characters

Request example

The following is a sample request.

curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/usage-plans' \
--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": 10,
    "dayQuotaRequest": 5,
    "rateRps": 2,
    "quotaCondition": "2xx",
    "usagePlanDescription": "usage plan",
    "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": 2,
        "usagePlanName": "usageplan000",
        "usagePlanDescription": "usage plan",
        "dayQuotaRequest": 5,
        "quotaCondition" : "2xx",
        "monthQuotaRequest": 10,
        "domainCode": "PUB",
        "associatedStagesCount": 0
    }
}

Was this article helpful?

What's Next

Delete usage plan

Table of contents

Request
Response