Stage 메서드 설정 덮어쓰기

Prev Next

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

지정한 Stage의 메서드 설정을 새로 지정한 메서드 설정으로 덮어쓰기합니다.

요청

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

메서드 URI
PATCH /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 Product ID
api-id String Required API ID
stage-id String Required Stage ID
deployment-no Long Required Deployment 번호
resource-id String Required Stage의 Resource ID
method-name String Required 설정을 덮어쓰기할 메서드
  • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD

요청 구문

요청 구문은 다음과 같습니다.

{
    "cacheTtlSec" : 0,
    "throttleRps" : 6,
    "isInherit" : true,
    "endpointDomain" : "endpointDomain"
}

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
cacheTtlSec Integer Optional API 캐시 TTL
  • 0~3600초
throttleRps Integer Optional 메서드별 초당 요청 수 한도
  • 0~2,147,483,647
isInherit Boolean Required Stage 기본 설정 준수 여부
  • true | false
    • true: 준수함
    • false: 준수 안 함
endpointDomain String Optional 엔드포인트 도메인

요청 예시

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

curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/***3kew***/apis/***hhdy***/stages/***sd32***/deployments/250***/resources/***uku7***/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}' \
--header 'Content-Type: application/json' \
--data '{
    "cacheTtlSec" : 0,
    "throttleRps" : 6,
    "isInherit" : true,
    "endpointDomain" : "https://test.****"
}'

응답

응답 형식을 설명합니다.

응답 구문

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

{
    "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": 256366,
    "methodName": "PUT",
    "methodCode": "0003",
    "resourceId": "1lynl7fvad",
    "invokeUrl": "https://rl5qpeuk8w.apigw.ntruss.com/new_api/test/",
    "restUrl": "test - PUT /",
    "endpointCode": "0007",
    "endpointConfigJson": "{\"httpStatus\":200,\"response\":\"\",\"headers\":{}}",
    "isInherit": true
  }
}