setUserConfigurationList

Available in VPC

Sets Notebook specifications configured by the user.

Requests

Request parameters

Request header

See common guide.

Request body

• JSON

  {
    "id": "string",
    "userConfigurations": [
      {
        "componentName": "string",
        "name": "string",
        "value": "string"
      }
    ]
  }
  

• XML

  <?xml version="1.0" encoding="UTF-8"?>
  <SetNotebookUserConfigurationListRequest>
    <id>string</id>
    <userConfigurations>
      <componentName>string</componentName>
      <name>string</name>
      <value>string</value>
    </userConfigurations>
  </SetNotebookUserConfigurationListRequest>
  

Responses

Response bodies

• JSON

    {
      "message": "string",
      "success": true
    }
  

• XML

  <?xml version="1.0" encoding="UTF-8"?>
    <SetNotebookUserConfigurationListResponse>
        <message>string</message>
        <success>true</success>
    </SetNotebookUserConfigurationListResponse>
  

Errors

See DataForest overview.

Examples

Request examples

POST https://df.apigw.ntruss.com/api/v2/notebooks/setUserConfigurationList
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: F5O55GOTR4CqYJqPDnCu
{
  "id": "57LdGyOt7xXefniX27qWkp",
  "userConfigurations": [
    {
      "name": "Access Password",
      "value": "qaz123QAZ!@#",
      "componentName": "Jupyter Lab"
    }
     ]
}

curl -X POST "https://df.beta-apigw.ntruss.com/api/v2/notebooks/setUserConfigurationList" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu" \
-H "x-ncp-apigw-timestamp: 1684892443931" \
-H "x-ncp-apigw-signature-v2: 74j5KqcSF8CpfaASzqGLQE2Io3bHkKnWz/CRf6thEyU=" \
-d "{ \"id\": \"57LdGyOt7xXefniX27qWkp\", \"userConfigurations\": [ { \"name\": \"Access Password\", \"value\": \"qaz123QAZ!@#\", \"componentName\": \"Jupyter Lab\" } ]}"

Response examples

• HTTP

  HTTP Status	Description
  200	OK

• BASH

  {
      "success": true
  }
  

Errors examples

• HTTP

  HTTP Status	Description
  400	invalid request parameters

• BASH

  {
    "message": "invalid request parameter (constraint violation Not available, notebook user configuration id's value 'qaz1@#')",
    "success": false
  }