View stage method settings

Available in Classic and VPC

View the settings information of a specified stage method.

Request

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

Method	URI
GET	/products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments/{deployment-no}/resources/{resource-id}/methods/{method-name}

Request headers

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

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`product-id`	String	Required	Product ID that the stage belongs to 0 - 10 characters Check through the View product list action
`api-id`	String	Required	ID of the API that the stage belongs to 0 - 10 characters Check through the View API action
`stage-id`	String	Required	ID of the stage whose method settings you want to view 0 - 10 characters Check through the View stage list action
`deployment-no`	Long	Required	Deployment number of the stage Check through View stage list
`resource-id`	String	Required	Resource ID of the stage 0 - 10 characters Check through View resource list
`method-name`	String	Required	Method to view `ANY` \| `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH` \| `OPTIONS` \| `HEAD`

Request example

The following is a sample request.

curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***26c7***/deployments/256***/resources/***cd4q***/methods/GET' \
--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.

{
    "stageMethod" : {
        "resourceId" : "resourceId",
        "endpointCode" : "endpointCode",
        "resourcePath" : "resourcePath",
        "methodName" : "ANY",
        "isInherit" : true,
        "methodCode" : "methodCode",
        "endpointDomain" : "endpointDomain",
        "cacheTtlSec" : 0,
        "restUrl" : "restUrl",
        "throttleRps" : 1,
        "endpointActionId" : "endpointActionId",
        "invokeUrl" : "invokeUrl",
        "stageDeploymentNo" : 6,
        "endpointConfigJson" : "endpointConfigJson"
    }
}

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.

{
    "stageMethod": {
        "stageDeploymentNo": 256***,
        "methodName": "GET",
        "methodCode": "0001",
        "resourceId": "***cd4q***",
        "invokeUrl": "https://***ksk9***.apigw.ntruss.com/api000/stage001/{domainCode}",
        "restUrl": "stage001 - GET /{domainCode}",
        "endpointCode": "0006",
        "endpointConfigJson": "{\"stream\":false,\"method\":\"GET\",\"url\":\"/{domainCode}\"}",
        "isInherit": true
    }
}