ゲートウェイレスポンスステータスコードの追加
    • PDF

    ゲートウェイレスポンスステータスコードの追加

    • PDF

    記事の要約

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

    定義されたゲートウェイのレスポンスステータスコードを変更します。

    リクエスト

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

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

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    product-idStringRequiredAPIが属する Product ID
    api-idStringRequiredレスポンスステータスコードを変更する対象 APIの ID
    response-typeStringRequiredゲートウェイレスポンスのタイプ

    リクエスト構文

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

    {
      "statusCode" : 0
    }
    

    リクエストボディ

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

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

    リクエスト例

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

    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
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.