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 メソッド別1秒当たりのリクエスト数の限度
  • 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
  }
}