getDetail

Available in VPC

Get details of the Data Forest app.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Data Forest APIs, see Data Forest request headers.

Request body

You can include the following data in the body of your request:

Request example

The request example is as follows:

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***"
}'

Response

This section describes the response format.

Response body

See GetAppDetailResponse for the response body.

Response status codes

For information about the HTTP status codes common to all Data Forest APIs, see Data Forest response status codes.

Response example

The response example is as follows:

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