getDetail

VPC環境で利用できます。

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

リクエスト

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

リクエストヘッダ

Data Forest APIで共通して使用されるヘッダの詳細は、Data Forestのリクエストヘッダをご参照ください。

リクエストボディ

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

リクエスト例

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

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

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

Data Forest APIで共通して使用されるレスポンスステータスコードの詳細は、Data Forestのレスポンスステータスコードをご参照ください。

レスポンス例

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

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