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

> ## 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文書の照会

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

全アカウントの Productの中から指定した Productの文書を照会します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| GET | /published-products/{product-Id}/documents |

### リクエストヘッダ

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

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `offset` | Long | Optional | レスポンスデータの開始点 - 0~9,223,372,036,854,775,807 - `limit`と共にページネーションの実装に使用 |
| `limit` | Long | Optional | レスポンスデータの最大数 - 1~9,223,372,036,854,775,807 - `offset`と共にページネーションの実装に使用 |
| `apiName` | String | Optional | API名 - 0~20文字 |

### リクエスト例

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

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

## レスポンス

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

### レスポンス構文

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

```
{
    "apiPage" : {
        "total" : 6,
        "content" : [ {
            "apiName" : "apiName",
            "domainCode" : "domainCode",
            "stages" : [ {
                "deployedStageDeploymentNo" : 0,
                "stageName" : "stageName",
                "host" : "host",
                "stageId" : "stageId"
            } ],
            "apiDescription" : "apiDescription",
            "apiId" : "apiId"
        } ]
    }
}
```

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

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)をご参照ください。

### レスポンス例

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

```
{
    "apiPage": {
        "content": [
            {
                "stages": [
                    {
                        "stageId": "***5ei7***",
                        "stageName": "stage",
                        "deployedStageDeploymentNo": 251***,
                        "host": "https://***ksk9***.apigw.ntruss.com"
                    }
                ],
                "apiId": "***51hs***",
                "apiName": "api000",
                "apiDescription": "",
                "domainCode": "PUB"
            }
        ],
        "total": 1
    }
}
```