setConfiguration
    • PDF

    setConfiguration

    • PDF

    記事の要約

    VPC環境で利用できます。

    AIワークスペース設定を変更します。

    リクエスト

    リクエストパラメータ

    パラメータ名要否タイプ制約事項説明
    idYESString最大22文字まで入力- AIワークスペースの ID
    - idは AI Workspacesの getList APIを通じて取得可能
    configurationYESAiAppTypeSpec- AiAppTypeSpecのデータタイプ
    - AI Workspacesの設定

    リクエストヘッダ

    共通ガイド参照

    リクエストボディ

    • JSON
        {
            "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",
                "workdir": "string"
                },
                "name": "string",
                "queueName": "gpu",
                "resource": {
                "cpuCount": 0,
                "gpuCount": 0,
                "gpuModel": "T4",
                "memoryMb": 0
                },
                "userPackageUri": "string"
            },
            "id": "string"
        }
      
    • XML
        <?xml version="1.0" encoding="UTF-8"?>
        <SetAiWorkspaceConfigurationRequest>
            <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>
                    <workdir>string</workdir>
                </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>
            <id>string</id>
        </SetAiWorkspaceConfigurationRequest>
      

    レスポンス

    レスポンスボディ

    • JSON
        {
            "id": "string",
            "message": "string",
            "success": true
        }
      
    • XML
      <?xml version="1.0" encoding="UTF-8"?>
        <SetAiWorkspaceConfigurationResponse>
            <id>string</id>
            <message>string</message>
            <success>true</success>
        </SetAiWorkspaceConfigurationResponse>
      

    エラーコード

    DataForest概要参照

    リクエスト例

    POST https://df.apigw.ntruss.com/api/v2/aiworkspaces/setConfiguration
    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
    
    {
      "configuration": {
        "data": {
          "input": [
            {
              "hdfs": "/user/<アカウント-名>/data_in",
              "path": "data_in"
            }
          ],
          "output": [
            {
              "hdfs": "/user/<アカウント-名>/data_out",
              "overwrite": false,
              "path": "data_out"
            }
          ]
        },
        "docker": {
          "args": "",
          "command": "<実行するスクリプトまたはコマンド>",
          "env": {},
          "exposeTcpPorts": [],
          "image": "<Docker画像>:<Docker画像のバージョン>",
          "workdir": "<AIワークスペース-名>"
        },
        "name": "<AIワークスペース-名>",
        "queueName": "gpu",
        "resource": {
          "cpuCount": 1,
          "gpuCount": 1,
          "gpuModel": "<GPU-モデル>",
          "memoryMb": integer
        },
        "userPackageUri": ""
      },
      "id": "5R4q4qDy7AafDHz9IeTIfu"
    }
    
    curl -X POST "https://df.apigw.ntruss.com/api/v2/aiworkspaces/setConfiguration" \
    -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 "{ \"configuration\": { \"data\": { \"input\":  { \"hdfs\": \"/user/<アカウント-名>/data_in\", \"path\": \"data_in\" } , \"output\":  { \"hdfs\": \"/user/<アカウント-名>/data_out\", \"overwrite\": true, \"path\": \"data_out\" }  }, \"docker\": { \"args\": \"\", \"command\": \"<実行するスクリプトまたはコマンド>\", \"env\": { }, \"exposeTcpPorts\": [  ],  \"image\": \"<Docker画像>:<Docker画像のバージョン>\", \"workdir\": \"<AIワークスペース-名>\" }, \"name\": \"<AIワークスペース-名>\", \"queueName\": \"gpu\", \"resource\": { \"cpuCount\": 1, \"gpuCount\": 1, \"gpuModel\": \"<GPU-モデル>\", \"memoryMb\": integer }, \"userPackageUri\": \"\" }, \"id\": \"5R4q4qDy7AafDHz9IeTIfu\"}" \
    

    レスポンス例

    • HTTP

      HTTP StatusDescription
      200OK
    • BASH

      {
          "success": true,
          "message": "success",
          "id": "5R4q4qDy7AafDHz9IeTIfu"
      }
      

    この記事は役に立ちましたか?

    What's Next
    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.