View usage plan with stage ID
- Print
- PDF
View usage plan with stage ID
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
View the list of usage plans based on whether the specified stage has a usage plan associated with it.Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /usage-plans |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
offset | Long | Optional | Starting point of the response data
|
limit | Long | Optional | Maximum number of response data
|
stageId | String | Required | Stage ID
|
associated | Boolean | Optional | Whether the usage plan is associated with a stage
|
Request example
The following is a sample request.
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/usage-plans?stageId=***5ei7***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
Response
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"total" : 0,
"usagePlans" : [ {
"domainCode" : "domainCode",
"usagePlanId" : "usagePlanId",
"associatedStagesCount" : 6,
"disabled" : true,
"permission" : "permission",
"usagePlanName" : "usagePlanName",
"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.
{
"usagePlans": [
{
"usagePlanId": "***9rpm***",
"usagePlanName": "usageplan",
"associatedStagesCount": 1,
"domainCode": "PUB"
}
],
"total": 1
}
Was this article helpful?