ゲートウェイレスポンスの照会
    • PDF

    ゲートウェイレスポンスの照会

    • PDF

    記事の要約

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

    API Gatewayサービスで発生するゲートウェイのレスポンスリストを照会します。

    リクエスト

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

    メソッドURI
    GET/products/{product-id}/apis/{api-id}/responses

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    product-idStringRequiredAPIが属する Product ID
    api-idStringRequiredレスポンスを照会する対象 APIの ID

    リクエスト例

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

    curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/responses' \
    --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'
    

    レスポンス

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

    レスポンス構文

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

    {
        "gatewayResponses": [
            {
                "apiId": "apiId",
                "responseType": "responseType",
                "responseName": "headerName",
                "statusCode": 000,
                "headers": [
                    {
                        "apiId": "apiId",
                        "responseType": "responseType",
                        "headerName": "header",
                        "headerValue": "value"
                    }
                ],
                "templates": [
                    {
                        "apiId": "apiId",
                        "responseType": "responseType",
                        "contentType": "application/json",
                        "mappingTemplate": "mappingTemplate"
                    }
                ],
                "default": false
            }
        ]
    }
    

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

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

    レスポンス例

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

    {
        "gatewayResponses": [
            {
                "apiId": "cvcohvd2xj",
                "responseType": "AUTHENTICATION_FAILED",
                "responseName": "Authentication Failed",
                "statusCode": 401,
                "headers": [
                    {
                        "apiId": "cvcohvd2xj",
                        "responseType": "AUTHENTICATION_FAILED",
                        "headerName": "header",
                        "headerValue": "value"
                    }
                ],
                "templates": [
                    {
                        "apiId": "cvcohvd2xj",
                        "responseType": "AUTHENTICATION_FAILED",
                        "contentType": "application/json",
                        "mappingTemplate": "{  \n            \"error\":{  \n               \"errorCode\":\"${context.error.errorCode}\",\n               \"message\":\"${context.error.messageString}\",\n               \"details\":\"$!{context.error.details}\"\n            }\n         }"
                    },
                    {
                        "apiId": "cvcohvd2xj",
                        "responseType": "AUTHENTICATION_FAILED",
                        "contentType": "application/xml",
                        "mappingTemplate": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n     <Message>\n        <error>\n           <errorCode>${context.error.errorCode}</errorCode>\n           <message>${context.error.messageString}</message>\n           <details>$!{context.error.details}</details>\n        </error>\n     </Message>"
                    }
                ],
                "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.