---
title: "getDetail"
slug: "analytics-dataforest-apps-getdetail"
updated: 2026-09-17T09:57:35Z
published: 2026-09-17T09:57:35Z
canonical: "api.ncloud-docs.com/analytics-dataforest-apps-getdetail"
---

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

# getDetail

VPC環境で利用できます。

Data Forestアプリの詳細情報を照会します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| POST | /api/v2/apps/getDetail |

### リクエストヘッダ

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

### リクエストボディ

リクエストボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `id` | String | Required | アプリ固有 ID - 0~22文字 - UUIDを Base62に変換した形式 - [getList](/docs/ja/analytics-dataforest-apps-getlist)を参照 |

### リクエスト例

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

```
curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/apps/getDetail' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "id": "***ziexhg0FcWx5eGUA***"
}'
```

## レスポンス

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

### レスポンスボディ

レスポンスボディの詳細は、[GetAppDetailResponse](/docs/ja/common-vapidatatype-getappdetailresponse)をご参照ください。

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

Data Forest APIで共通して使用されるレスポンスステータスコードの詳細は、[Data Forestのレスポンスステータスコード](/docs/ja/analytics-dataforest#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

```
{
    "success": true,
    "id": "***ziexhg0FcWx5eGUA***",
    "appId": "***ziexhg0FcWx5eGUA***",
    "name": "app001",
    "appTypeId": "DEV-1.0.0",
    "version": "v1",
    "lifetime": "7 days, 0:0:0 (604800 seconds)",
    "queueName": "longlived",
    "description": "DEV-1.0.0",
    "state": "RUNNING",
    "links": {
        "shell": "https://*****--*****--shell--8080.df-proxy.kr.ch.naverncp.com",
        "supervisor": "https://*****--*****--shell--9001.df-proxy.kr.ch.naverncp.com"
    },
    "components": [
        {
            "name": "shell",
            "state": "STABLE",
            "memoryMb": 1,
            "cpuCount": 1,
            "image": "********.kr.private-ncr.ntruss.com/dfnew-env:20241217",
            "containers": [
                {
                    "id": "container_***_***5213280***_0231_01_000002",
                    "name": "shell-0",
                    "state": "READY",
                    "hostName": "shell-0.*****.*****.kr.ch.naverncp.com"
                }
            ]
        }
    ]
}
```