リクエスト

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

メソッド	URI
POST	/products/{product-id}/apis/{api-id}/responses/{response-type}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`product-id`	String	Required	APIが属する Product ID 1~10文字 Productリストの照会を通じて確認
`api-id`	String	Required	レスポンスステータスコードを変更する対象 APIの ID 1~10文字 APIの照会を通じて確認
`response-type`	String	Required	ゲートウェイレスポンスのタイプ 1~45文字ゲートウェイレスポンスの照会を通じて確認

リクエスト構文

リクエスト構文は次の通りです。

{
  "statusCode" : 0
}

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`statusCode`	Integer	Required	変更後のレスポンスステータスコード

リクエスト例

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

curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/responses/AUTHENTICATION_FAILED' \
--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 '{
  "statusCode" : 401
}'

レスポンス

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

レスポンス構文

レスポンス構文は次の通りです。

{
    "apiId": "apiId",
    "responseType": "responseType",
    "responseName": "responseName",
    "statusCode": 000,
    "default": false
}

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

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

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "apiId": "cvcohvd2xj",
    "responseType": "AUTHENTICATION_FAILED",
    "responseName": "Authentication Failed",
    "statusCode": 401,
    "default": false
}

この記事は役に立ちましたか?

リクエスト
レスポンス