MENU
      View stage associated with usage plan

        View stage associated with usage plan


        Article summary

        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:

        MethodURI
        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.

        FieldTypeRequiredDescription
        usage-plan-idStringRequiredID of usage plan whose stages you want to view

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        offsetLongOptionalStarting point of the response data
        • 0 - 9,223,372,036,854,775,807
        • It is used with limit to implement pagination
        limitLongOptionalMaximum number of response data
        • 1 - 9,223,372,036,854,775,807
        • It is used with offset to implement pagination
        nameStringOptionalName of stage to view
        • 1 - 20 characters

        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}'
        Curl

        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"
          }
        }
        JSON

        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"
            }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.