getUserConfigurationSpecList
    • PDF

    getUserConfigurationSpecList

    • PDF

    기사 요약

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

    노트북 구성에 필요한 사용자 설정을 확인합니다.

    요청

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    typeNameYESString- typeName은 Notebooks의 getTypeList API를 통해 확인 가능

    요청 헤더

    공통 가이드 참조

    요청 바디

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

    오류코드

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

    예시

    요청 예시

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

    응답 예시

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

    오류 코드 예시

    • HTTP

      HTTP StatusDescription
      403not allowed to access
    • BASH

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

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

    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.