View stage associated with usage plan

Available in Classic and VPC

Request

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

Request headers

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

Request path parameters

The following describes the parameters.

Request syntax

The request syntax is as follows.

{
    "usagePlanId" : "usagePlanId"
}

Request body

The following describes the request body.

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