Stage 메서드 설정 조회

Classic/VPC 환경에서 이용 가능합니다.

지정한 Stage 메서드의 설정 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

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

요청 헤더

API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`product-id`	String	Required	Stage가 속한 Product ID 0~10자 Product 목록 조회 액션을 통해 확인
`api-id`	String	Required	Stage가 속한 API ID 0~10자 API 조회 액션을 통해 확인
`stage-id`	String	Required	메서드 설정 정보를 조회할 Stage ID 0~10자 Stage 목록 조회 액션을 통해 확인
`deployment-no`	Long	Required	Stage의 Deployment 번호 Stage 목록 조회를 통해 확인
`resource-id`	String	Required	Stage의 Resource ID 0~10자 Resource 목록 조회를 통해 확인
`method-name`	String	Required	조회할 메서드 `ANY` \| `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH` \| `OPTIONS` \| `HEAD`

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://apigateway.apigw.gov-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}'

응답

응답 형식을 설명합니다.

응답 구문

응답 구문은 다음과 같습니다.

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

응답 상태 코드

API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

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