MENU
      getDetail

        getDetail


        Article summary

        Available in VPC

        Detailed Data Forest account information is viewed.

        Requests

        Request Parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        idYESStringEnter up to 22 characters.- app identifier UUID (base62)
        - id can be acquired through getList API of Apps.

        Request headers

        See common guide.

        Request bodies

        • JSON
          {
              "id": "string"
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <GetAppDetailRequest>
              <id>string</id>
          </GetAppDetailRequest>
          XML

        Responses

        Response bodies

        GetAppDetailResponse

        • JSON
          {
              "components": [
                  {
                  "allocated": 0,
                  "containerCount": 0,
                  "containers": [
                      {
                      "hostName": "string",
                      "id": "string",
                      "launchedAt": "2023-05-08T02:22:21.249Z",
                      "name": "string",
                      "state": "string"
                      }
                  ],
                  "cpuCount": 0,
                  "desired": 0,
                  "image": "string",
                  "memoryMb": 0,
                  "name": "string",
                  "state": "string"
                  }
              ],
              "appId": "string",
              "appTypeId": "string",
              "description": "string",
              "id": "string",
              "lifetime": "string",
              "links": {
                  "additionalProp1": "string",
                  "additionalProp2": "string",
                  "additionalProp3": "string"
              },
              "message": "string",
              "name": "string",
              "queueName": "dev",
              "state": "string",
              "success": true,
              "version": "string"
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <GetAppDetailResponse>
              <components>
                  <allocated>0</allocated>
                  <containerCount>0</containerCount>
                  <containers>
                      <hostName>string</hostName>
                      <id>string</id>
                      <launchedAt>2023-05-08T02:23:28.089Z</launchedAt>
                      <name>string</name>
                      <state>string</state>
                  </containers>
                  <cpuCount>0</cpuCount>
                  <desired>0</desired>
                  <image>string</image>
                  <memoryMb>0</memoryMb>
                  <name>string</name>
                  <state>string</state>
              </components>
              <appId>string</appId>
              <appTypeId>string</appTypeId>
              <description>string</description>
              <id>string</id>
              <lifetime>string</lifetime>
              <links>
                  <additionalProp>string</additionalProp>
              </links>
              <message>string</message>
              <name>string</name>
              <queueName>dev</queueName>
              <state>string</state>
              <success>true</success>
              <version>string</version>
          </GetAppDetailResponse>
          XML

        Errors

        See DataForest overview

        Examples

        Request Examples

        • HTTP

          POST https://df.apigw.ntruss.com/api/v2/apps/getDetail
          HOST: df.apigw.ntruss.com
          Content-Type: application/json
          x-ncp-apigw-timestamp: 1505290625682
          x-ncp-iam-access-key: D78BB444D6D3C84CA38A
          x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
          {
          "id": "A4LI7d5mRn1f6M2HxZAEE2",
          }
          HTTP
        • BASH

          curl -X POST "https://df.apigw.ntruss.com/api/v2/apps/getDetail
          " \
          -H "accept: application/json" \
          -H "Content-Type: application/json" \
          -H "x-ncp-apigw-timestamp:1505290625682" \
          -H "x-ncp-iam-access-key:D78BB444D6D3C84CA38A" \
          -H "x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=" \
          -d "{ \"id\": \"diYqhQTq8C2csiy0neW2Jq\"}" \
          Bash

        Response examples

        • HTTP

          HTTP StatusDescription
          200OK
        • BASH

          {
              "success": true,
              "id": "diYqhQTq8C2csiy0neW2Jq",
              "appId": "application_1681893964678_0097",
              "name": "dev24x7",
              "appTypeId": "DEV-1.0.0",
              "version": "v1",
              "lifetime": "6 days, 23:57:54 (604674 seconds)",
              "queueName": "longlived",
              "description": "DEV-1.0.0",
              "state": "STABLE",
              "links": {
                  "supervisor ": "https://test--dev24x7--shell--9001.proxy.kr.df.naverncp.com",
                  "AppMaster": "https://rm1.kr.df.naverncp.com:9090/cluster/app/application_1681893964678_0097",
                  "shell": "https://test--dev24x7--shell--8080.proxy.kr.df.naverncp.com"
              },
              "components": [
                  {
                  "name": "shell",
                  "state": "STABLE",
                  "desired": 1,
                  "allocated": 1,
                  "memoryMb": 2048,
                  "cpuCount": 1,
                  "image": "rgstry.kr.df.naverncp.com/dataforest/df-env:20220826",
                  "containers": [
                      {
                      "id": "container_e826_1681893964678_0097_01_000002",
                      "name": "shell-0",
                      "state": "READY",
                      "launchedAt": "2023-05-08T11:54:35.585+09:00",
                      "hostName": "shell-0.dev24x7.test.kr.df.naverncp.com"
                      }
                  ]
                  }
              ]
          }
          JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.