ゲートウェイレスポンスヘッダの削除

Prev Next

Classic/VPC環境で利用できます。

ゲートウェイレスポンスにユーザー定義したレスポンスヘッダを削除します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
DELETE /products/{product-id}/apis/{api-id}/responses/{response-type}/headers/{header-name}

リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
product-id String Required APIが属する Product ID
api-id String Required レスポンスヘッダを削除する対象の APIの ID
response-type String Required ゲートウェイレスポンスのタイプ
header-name String Required 対象ヘッダの名前
  • 1~45文字

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request DELETE 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/responses/AUTHENTICATION_FAILED/headers/codeType' \
--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 '{
  "headerName" : "codeType",
  "headerValue" : "normal"
}'

レスポンス

レスポンス形式を説明します。

レスポンスステータスコード

API Gateway APIで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。