getList

Available in VPC

Views all Data Forest account app lists.

Requests

Request parameters

Request headers

See common guide.

Request bodies

• JSON

    {
        "search": {
            "accountId": "string"
            }
    }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetAppListRequest>
        <search>
            <accountId>string</accountId>
        </search>
    </GetAppListRequest>
  

Responses

Response bodies

GetAppListResponse

• JSON

    {
        "contents": [
            {
            "accountId": "string",
            "accountName": "string",
            "disabled": true,
            "finishedAt": "2023-05-08T02:10:17.223Z",
            "id": "string",
            "lifetimeMillis": 0,
            "name": "string",
            "queueName": "longlived",
            "startedAt": "2023-05-08T02:10:17.223Z",
            "state": "string"
            }
        ],
        "message": "string",
        "success": true,
        "total": 0
    }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetAppListResponse>
        <contents>
            <accountId>string</accountId>
            <accountName>string</accountName>
            <disabled>true</disabled>
            <finishedAt>2023-05-08T02:10:31.195Z</finishedAt>
            <id>string</id>
            <lifetimeMillis>0</lifetimeMillis>
            <name>string</name>
            <queueName>longlived</queueName>
            <startedAt>2023-05-08T02:10:31.195Z</startedAt>
            <state>string</state>
        </contents>
        <message>string</message>
        <success>true</success>
        <total>0</total>
    </GetAppListResponse>
  

Errors

See DataForest overview

Examples

Request Examples

• HTTP

  POST https://df.apigw.ntruss.com/api/v2/apps/getList
  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=
  
  {
  "search": {
      "accountId": "diYqhQTq8C2csiy0neW2Jq"
      }
  }
  

• BASH

  curl -X POST "https://df.apigw.ntruss.com/api/v2/apps/getList" \
  -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 "{ \"search\": { \"accountId\": \"diYqhQTq8C2csiy0neW2Jq\" }}" \
  

Response examples

• HTTP

  HTTP Status	Description
  200	OK

• BASH

  {
      "success": true,
      "total": 1,
      "contents": [
          {
          "id": "diYqhQTq8C2csiy0neW2Jq",
          "name": "dev24x7",
          "state": "RUNNING",
          "queueName": "longlived",
          "accountId": "cAAH2NqfDsGdgMKcgMpShH",
          "accountName": "test",
          "startedAt": "2023-05-08T11:54:28+09:00",
          "lifetimeMillis": 604800,
          "disabled": false
          }
      ]
  }