View stage
    • PDF

    View stage

    • PDF

    Article summary

    Available in Classic and VPC

    View the details of a specified stage.

    Request

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

    MethodURI
    GET/products/{product-id}/apis/{api-id}/stages/{stage-id}

    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 stage belongs to
    api-idStringRequiredID of the API that the stage belongs to
    stage-idStringRequiredID of the stage to view

    Request example

    The following is a sample request.

    curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***fh5o***' \
    --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.

    {
        "stage" : {
            "canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
            "modifier" : "modifier",
            "canaryEndpointDomain" : "canaryEndpointDomain",
            "canaryThrottleRps" : 5,
            "cacheTtlSec" : 0,
            "stageName" : "stageName",
            "throttleRps" : 4,
            "monthQuotaRequest" : 9,
            "canaryCacheTtlSec" : 6,
            "canaryDistributionRate" : 5.962134,
            "apiId" : "apiId",
            "stageId" : "stageId",
            "deployedStageDeploymentNo" : 7,
            "useDistributionRate" : true,
            "canaryDeploymentDescription" : "canaryDeploymentDescription",
            "dayQuotaRequest" : 2,
            "isMaintenance" : true,
            "rateRps" : 3,
            "endpointDomain" : "endpointDomain",
            "ipAclList" : "ipAclList",
            "canaryDeploymentNo" : 1,
            "regTime" : "2000-01-23T04:56:07.000+00:00",
            "response" : "response",
            "canaryConditions" : [ {
                "parameterName" : "parameterName",
                "parameterCode" : "REQUEST_HEADER",
                "parameterValue" : "parameterValue"
            } ],
            "tenantId" : "tenantId",
            "ipAclCode" : "ALLOWED",
            "statusCode" : 2,
            "enabledContentEncoding": true,
            "minimumCompressionSize": 0
        }
    }
    

    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.

    {
        "stage": {
            "tenantId": "***e230cebc1402ba89b148896951***",
            "modifier": "***d3020-5bb7-11ec-bfb8-246e96591***",
            "stageId": "***fh5o***",
            "apiId": "***51hs***",
            "stageName": "stage000",
            "endpointDomain": "https://test***.test.com",
            "deployedStageDeploymentNo": 250***,
            "regTime": "2024-05-07T23:48:47Z",
            "isMaintenance": false,
            "certificateId": "***8e2i***",
            "enabledContentEncoding": false
        }
    }
    

    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.