MENU
      getUserConfigurationSpecList

        getUserConfigurationSpecList


        Article summary

        Available in VPC

        Views the user settings necessary for composition of Notebooks.

        Requests

        Request Parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        typeNameYESString- typeName can be verified through Notebooks’ getTypeList API

        Request headers

        See common guide.

        Request bodies

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

        Errors

        HTTP StatusDescription
        400invalid request parameters
        403not allowed to access
        404no such element
        500unexpected error

        Examples

        Request Examples

        POST https://df.apigw.ntruss.com/api/v2/notebooks/getUserConfigurationSpecList
        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
        
        {
          "typeName": "Jupyter Lab"
        }
        HTTP
        curl -X POST "https://df.apigw.ntruss.com/api/v2/notebooks/getUserConfigurationSpecList" \
        -H "accept: application/json" \
        -H "Content-Type: application/json" \
        -H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu" \
        -H "x-ncp-apigw-timestamp: 1684750884177" \
        -H "x-ncp-apigw-signature-v2: HxotNU+ZrmqWNVM+j3dd36xWncpIRcHPi4egeKU+3Dw=" \
        -d "{ \"typeName\": \"Jupyter Lab\"}"
        Bash

        Response examples

        • HTTP

          HTTP StatusDescription
          200OK
        • BASH

          {
              "success": true,
              "userConfigurationSpecs": [
                {
                  "name": "Access Password",
                  "value": "",
                  "componentName": "Jupyter Lab",
                  "regularExpression": "^[a-zA-Z][a-zA-Z0-9]{1,7}$",
                  "isMasking": true,
                  "isMandatory": true
                },
                {
                  "name": "Access Key",
                  "value": "",
                  "componentName": "Object Storage",
                  "regularExpression": ".*",
                  "isMasking": true,
                  "isMandatory": false
                },
                {
                  "name": "Secret Key",
                  "value": "",
                  "componentName": "Object Storage",
                  "regularExpression": ".*",
                  "isMasking": true,
                  "isMandatory": false
                }
              ]
          }
          JSON

        Errors examples

        • HTTP

          HTTP StatusDescription
          403not allowed to access
        • BASH

          {
            "message": "resource ('string') is not allowed or not exists",
            "success": false
          }
          JSON

        Was this article helpful?

        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.