Classic/VPC環境で利用できます。
ゲートウェイレスポンスの本文とマッピングするテンプレートの内容を変更します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| PATCH | /products/{product-id}/apis/{api-id}/responses/{response-type}/templates |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
product-id |
String | Required | APIが属する Product ID
|
api-id |
String | Required | マッピングテンプレートを変更する対象の API ID
|
response-type |
String | Required | ゲートウェイレスポンスのタイプ
|
リクエスト構文
リクエスト構文は次の通りです。
{
"mappingTemplate" : "mappingTemplate",
"contentType" : "contentType"
}
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
mappingTemplate |
String | Required | 変更後のテンプレートの内容 |
contentType |
String | Required | コンテンツタイプ
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/responses/AUTHENTICATION_FAILED/templates' \
--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 '{
"mappingTemplate" : "{ \"error\" : \"${context.apiName}\" }",
"contentType" : "application/json"
}'
レスポンス
レスポンス形式を説明します。
レスポンスステータスコード
API Gateway APIで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。