---
title: "Product 문서 조회"
slug: "apigateway-published-getdocument"
tags: ["API Gateway", "Published Product"]
updated: 2026-09-17T09:16:01Z
published: 2026-09-17T09:16:01Z
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 문서 조회

<p class="platform-info type-classic/vpc">Classic/VPC 환경에서 이용 가능합니다.</p>
전체 계정의 Product 중 지정한 Product의 문서를 조회합니다.

## 요청 <a name="요청"></a>
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

| 메서드 | URI |
| :--- | :--- |
| GET | /api/v1/published-products/{product-Id}/documents |

### 요청 헤더 <a name="요청헤더"></a>
API Gateway에서 공통으로 사용하는 헤더에 대한 정보는 [API Gateway 요청 헤더](/docs/ai-application-service-apigateway#요청헤더)를 참조해 주십시오.

### 요청 경로 파라미터 <a name="요청경로파라미터"></a>
요청 경로 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| :--- | :--- | :--- | :--- |
| `product-id` | String | Required | 문서를 조회할 Product ID<ul><li>0~10자</li><li>[Product 목록 조회](/docs/apigateway-published-postproduct) 참조</li></ul> |

### 요청 쿼리 파라미터 <a name="요청쿼리파라미터"></a>
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| :--- | :--- | :--- | :--- |
| `offset` | Long | Optional | 응답 데이터의 시작 지점<ul><li>0~9,223,372,036,854,775,807</li><li>`limit`과 함께 페이지네이션 구현에 사용</li></ul> |
| `limit` | Long | Optional | 응답 데이터의 최대 수<ul><li>1~9,223,372,036,854,775,807</li><li>`offset`과 함께 페이지네이션 구현에 사용</li></ul> |
| `apiName` | String | Optional | API 이름<ul><li>0~20자</li></ul> |

### 요청 예시 <a name="요청예시"></a>
요청 예시는 다음과 같습니다.

```shell
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}'
```

## 응답 <a name="응답"></a>
응답 형식을 설명합니다.

### 응답 구문 <a name="응답구문"></a>
응답 구문은 다음과 같습니다.

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

### 응답 상태 코드 <a name="응답상태코드"></a>
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [API Gateway 응답 상태 코드](/docs/ai-application-service-apigateway#응답상태코드)를 참조해 주십시오.

### 응답 예시 <a name="응답예시"></a>
응답 예시는 다음과 같습니다.

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