MENU
      getDetail

        getDetail


        기사 요약

        VPC 환경에서 이용 가능합니다.

        AI 워크스페이스의 상세 정보를 조회합니다.

        요청

        요청 파라미터

        파라미터명필수 여부타입제약 사항설명
        idYESString최대 22자까지 입력- AI 워크스페이스 ID UUID(base62)
        - id는 AI Workspaces의 getList API를 통해서 획득 가능

        요청 헤더

        공통 가이드 참조

        요청 바디

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

        응답

        응답 바디

        GetAiWorkspaceDetailResponse

        • JSON
          {
              "accountId": "string",
              "accountName": "string",
              "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:49:34.219Z",
                  "modifiedAt": "2023-05-15T02:49:34.219Z"
                  }
              ],
              "createdAt": "2023-05-15T02:49:34.219Z",
              "description": "string",
              "id": "string",
              "imageVersion": "string",
              "message": "string",
              "modifiedAt": "2023-05-15T02:49:34.219Z",
              "name": "string",
              "success": true
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <GetAiWorkspaceDetailResponse>
              <accountId>string</accountId>
              <accountName>string</accountName>
              <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:50:38.010Z</createdAt>
                  <modifiedAt>2023-05-15T02:50:38.010Z</modifiedAt>
              </contents>
              <createdAt>2023-05-15T02:50:38.010Z</createdAt>
              <description>string</description>
              <id>string</id>
              <imageVersion>string</imageVersion>
              <message>string</message>
              <modifiedAt>2023-05-15T02:50:38.010Z</modifiedAt>
              <name>string</name>
              <success>true</success>
          </GetAiWorkspaceDetailResponse>
          XML

        오류코드

        DataForest 개요 참조

        예시

        요청 예시

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

        응답 예시

        • HTTP
          HTTP StatusDescription
          200OK
        • BASH
          {
              "success": true,
              "id": "5R4q4qDy7AafDHz9IeTIfu",
              "name": "<AI 워크스페이스-이름>",
              "accountName": "<계정-이름>",
              "description": "<AI 워크스페이스-설명>",
              "imageVersion": "<Docker 이미지>:<Docker 이미지 버전>",
              "createdAt": "2022-07-27T15:51:21.284+09:00",
              "modifiedAt": "2022-07-27T15:51:22.111+09:00",
              "contents": [
                  {
                  "configuration": {
                      "userPackageUri": "",
                      "queueName": "gpu",
                      "name": "<AI 워크스페이스-이름>",
                      "resource": {
                      "gpuModel": "<GPU-모델>",
                      "cpuCount": 1,
                      "gpuCount": 1,
                      "memoryMb": integer
                      },
                      "docker": {
                      "env": {},
                      "exposeTcpPorts": [],
                      "image": "<Docker 이미지>:<Docker 이미지 버전>",
                      "command": "<실행할 스크립트 또는 명령어>",
                      "args": ""
                      },
                      "data": {
                      "input": [
                          {
                          "hdfs": "/user/<계정-이름>/data_in",
                          "path": "data_in"
                          }
                      ],
                      "output": [
                          {
                          "hdfs": "/user/<계정-이름>/data_out",
                          "path": "data_out",
                          "overwrite": false
                          }
                      ]
                      }
                  },
                  "createdAt": "2022-07-27T15:51:21.284+09:00",
                  "modifiedAt": "2022-07-27T15:51:22.187+09:00"
                  }
              ]
          }
          JSON

        이 문서가 도움이 되었습니까?

        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.