View stage associated with usage plan
    • PDF

    View stage associated with usage plan

    • PDF

    Article summary

    Available in Classic and VPC

    View the stage associated with a specific usage plan among stages the belong to a specified API.

    Request

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

    MethodURI
    POST/products/{product-id}/apis/{api-id}/stages/search

    Request headers

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

    Request path parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    product-idStringRequiredProduct ID that the API belongs to
    api-idStringRequiredID of the API whose stage you want to view

    Request syntax

    The request syntax is as follows.

    {
        "usagePlanId" : "usagePlanId"
    }
    

    Request body

    The following describes the request body.

    FieldTypeRequiredDescription
    usagePlanIdStringRequiredID of usage plan whose stages you want to view

    Request example

    The following is a sample request.

    curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/search' \
    --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 '{
        "usagePlanId" : "***833g***"
    }'
    

    Response

    The following describes the response format.

    Response syntax

    The response syntax is as follows.

    {
        "stages" : [ {
            "stageName" : "stageName",
            "stageId" : "stageId"
        } ]
    }
    

    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": [
            {
                "stageId": "***fh5o***",
                "stageName": "stage000"
            },
            {
                "stageId": "***5ei7***",
                "stageName": "stage"
            }
        ]
    }
    

    Was this article helpful?

    What's Next
    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.