View stage associated with usage plan
- Print
- PDF
View stage associated with usage plan
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
View the details of stages associated with a specified usage plan.Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /usage-plans/{usage-plan-id}/stages |
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 whose stages you want to view
|
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
|
name | String | Optional | Name of stage to view
|
Request example
The following is a sample request.
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/usage-plans/***9rpm***/stages' \
--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,
"stages" : [ {
"apiName" : "apiName",
"stageName" : "stageName",
"productId" : "productId",
"apiId" : "apiId",
"productName" : "productName",
"stageId" : "stageId"
} ],
"usagePlan" : {
"domainCode" : "domainCode",
"monthQuotaRequest" : 1,
"dayQuotaRequest" : 6,
"rateRps" : 5,
"quotaCondition" : "quotaCondition"
}
}
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.
{
"stages": [
{
"productName": "product",
"apiName": "api000",
"stageName": "stage",
"stageId": "***5ei7***",
"productId": "***ksk9***",
"apiId": "***51hs***"
}
],
"total": 1,
"usagePlan": {
"domainCode": "PUB"
}
}
Was this article helpful?