getDetail

VPC環境で利用できます。

AIワークスペースの詳細情報を照会します。

リクエスト

リクエストパラメータ

リクエストヘッダ

共通ガイドを参照

リクエストボディ

• JSON

    {
    "id": "string"
    }
  

• XML

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

レスポンス

レスポンスボディ

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
    }
  

• 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>
  

エラーコード

Data Forestの概要を参照

例

リクエスト例

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

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\"}" \

レスポンス例

• HTTP

  HTTP Status	Description
  200	OK

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