---
title: "Product Overviewの照会"
slug: "apigateway-product-getoverview"
updated: 2026-09-17T09:57:26Z
published: 2026-09-17T09:57:26Z
canonical: "api.ncloud-docs.com/apigateway-product-getoverview"
---

> ## 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.

# Product Overviewの照会

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

指定した Productの Overviewを照会します。

## リクエスト

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

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

### リクエストヘッダ

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 | Overviewを照会する対象の Product ID - 0~10文字 - [Productリストの照会](/docs/ja/apigateway-product-getproductlist)を参照 |

### リクエスト例

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

```
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/overview' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

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

### レスポンス構文

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

```
{
    "apis" : [ {
        "apiName" : "apiName",
        "domainCode" : "domainCode",
        "methodsCount" : 2,
        "stages" : [ {
            "deployedStageDeploymentNo" : 0,
            "stageName" : "stageName",
            "host" : "host",
            "stageId" : "stageId"
        } ],
        "apiId" : "apiId"
    } ],
    "apiKeyCountInfo" : {
        "request" : 5,
        "total" : 5,
        "rejected" : 1,
        "accepted" : 0,
        "denied" : 6
    }
}
```

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

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、[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)をご参照ください。

### レスポンス例

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

```
{
    "apis": [
        {
            "stages": [
                {
                    "stageId": "***5ei7***",
                    "stageName": "stage",
                    "deployedStageDeploymentNo": 250***,
                    "host": "https://***ksk9***.apigw.ntruss.com"
                }
            ],
            "apiId": "***51hs***",
            "apiName": "api000",
            "methodsCount": 6
        }
    ],
    "apiKeyCountInfo": {
        "accepted": 0,
        "rejected": 0,
        "request": 0,
        "denied": 0,
        "total": 0
    }
}
```