---
title: "ゲートウェイレスポンスの照会"
slug: "apigateway-getresponses"
updated: 2026-09-17T09:57:24Z
published: 2026-09-17T09:57:24Z
canonical: "api.ncloud-docs.com/apigateway-getresponses"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

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

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

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

## リクエスト

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

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

### リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、[API Gatewayのリクエストヘッダ](/docs/ja/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `product-id` | String | Required | APIが属する Product ID - 1~10文字 - [Productリストの照会](/docs/ja/apigateway-product-getproductlist)を参照 |
| `api-id` | String | Required | レスポンスを照会する対象 APIの ID - 1~10文字 - [APIの照会](/docs/ja/apigateway-api-apis)を参照 |

### リクエスト例

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

```
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のレスポンスステータスコード](/docs/ja/ai-application-service-apigateway#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

```
{
    "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
        }
    ]
}
```