getConfigurationList

Available in VPC

Get AI workspace settings.

Request

Request parameter

Request headers

See the common guide

Request body

• JSON

    {
        "id": "string"
    }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetAiWorkspaceConfigurationListRequest>
        <id>string</id>
    </GetAiWorkspaceConfigurationListRequest>
  

Response

Response body

GetAiWorkspaceConfigurationListResponse

• JSON

    {
        "contents": [
            {
            "configuration": {
                "data": {
                "input": [
                    {
                    "hdfs": "string",
                    "path": "string"
                    }
                ],
                "output": [
                    {
                    "hdfs": "string",
                    "overwrite": true,
                    "path": "string"
                    }
                ]
                },
                "docker": {
                "args": "string",
                "command": "string",
                "env": {
                    "additionalProp1": "string",
                    "additionalProp2": "string",
                    "additionalProp3": "string"
                },
                "exposeTcpPorts": [
                    0
                ],
                "image": "string"
                },
                "name": "string",
                "queueName": "gpu",
                "resource": {
                "cpuCount": 0,
                "gpuCount": 0,
                "gpuModel": "T4",
                "memoryMb": 0
                },
                "userPackageUri": "string"
            },
            "createdAt": "2023-05-15T02:36:35.618Z",
            "modifiedAt": "2023-05-15T02:36:35.618Z"
            }
        ],
        "message": "string",
        "success": true,
        "total": 0
    }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetAiWorkspaceConfigurationListResponse>
        <contents>
            <configuration>
                <data>
                    <input>
                        <hdfs>string</hdfs>
                        <path>string</path>
                    </input>
                    <output>
                        <hdfs>string</hdfs>
                        <overwrite>true</overwrite>
                        <path>string</path>
                    </output>
                </data>
                <docker>
                    <args>string</args>
                    <command>string</command>
                    <env>
                        <additionalProp>string</additionalProp>
                    </env>
                    <exposeTcpPorts>0</exposeTcpPorts>
                    <image>string</image>
                </docker>
                <name>string</name>
                <queueName>gpu</queueName>
                <resource>
                    <cpuCount>0</cpuCount>
                    <gpuCount>0</gpuCount>
                    <gpuModel>T4</gpuModel>
                    <memoryMb>0</memoryMb>
                </resource>
                <userPackageUri>string</userPackageUri>
            </configuration>
            <createdAt>2023-05-15T02:39:27.020Z</createdAt>
            <modifiedAt>2023-05-15T02:39:27.020Z</modifiedAt>
        </contents>
        <message>string</message>
        <success>true</success>
        <total>0</total>
    </GetAiWorkspaceConfigurationListResponse>
  

Errors

See Data Forest overview

Examples

Request example

POST https://df.apigw.ntruss.com/api/v2/aiworkspaces/getConfigurationList
HOST: df.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: Azm1WBMWDgEONUCUbsVkB4tRIpc053uOHU8bitbQRtU=
x-ncp-apigw-timestamp: 1658898041497
x-ncp-iam-access-key: 17F9A6E9F72BD92ED94B

{
  "id": "5R4q4qDy7AafDHz9IeTIfu"
}

curl -X POST "https://df.apigw.ntruss.com/api/v2/aiworkspaces/getConfigurationList" \
-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\": \"5R4q4qDy7AafDHz9IeTIfu\"}" \

Response example

• HTTP

  HTTP Status	Description
  200	OK

• BASH

  {
      "success": true,
      "message": "success",
      "total": 1,
      "contents": [
      {
      "configuration": {
          "userPackageUri": "string",
          "queueName": "gpu",
          "name": "string",
          "resource": {
          "gpuModel": "T4",
          "cpuCount": 0,
          "gpuCount": 8,
          "memoryMb": 0
          },
          "docker": {
          "env": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
          },
          "exposeTcpPorts": [
              0
          ],
          "image": "dataforest/4b2ssizu3q7h8c0x_xlpawydv5:vz.uuswrbko164",
          "command": "string",
          "args": "string"
          },
          "data": {
          "input": [
              {
              "hdfs": "string",
              "path": "string"
              }
          ],
          "output": [
              {
              "hdfs": "string",
              "path": "string",
              "overwrite": true
              }
          ]
          }
          },
      "createdAt": "2023-05-15T02:44:51.362Z",
      "modifiedAt": "2023-05-15T02:44:51.362Z"
      }
      ]
  }