MENU
      View usage plan

        View usage plan


        Article summary

        Available in Classic and VPC

        View the details of 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}

        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 to view

        Request example

        The following is a sample request.

        curl --location --request GET '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}'
        Curl

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

        {
            "usagePlan": {
                "tenantId": "***e230cebc1402ba89b148896951***",
                "usagePlanId": "***wthl***",
                "rateRps": 2,
                "usagePlanName": "usageplan000",
                "usagePlanDescription": "usage plan",
                "dayQuotaRequest": 5,
                "monthQuotaRequest": 10,
                "domainCode": "PUB",
                "associatedStagesCount": 0
            }
        }
        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.