getList
    • PDF

    getList

    • PDF

    Article summary

    Available in VPC

    View the list of Created Notebooks.

    Requests

    Request Parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    accountIdYESString- Account identifier UUID (base62)
    Id can be obtained through getList API in Accounts
    pagingNO- limit should be 1 or higher.- limit: The maximum number of results to be searched.
    - offset: The number of results to be skipped.

    Request headers

    See common guide.

    Request bodies

    • JSON
      {
            "accountId": "string",
            "paging": {
              "limit": 10,
              "offset": 0
            }
      }
      
    • XML
      <?xml version="1.0" encoding="UTF-8"?>
      <GetNotebookListRequest>
        <accountId>string</accountId>
        <paging>
          <limit>10</limit>
          <offset>0</offset>
        </paging>
      </GetNotebookListRequest>
      

    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/getList
    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
    {
      "accountId": "2mUVZaHseGadiNFAg5MHjk",
      "paging": {
        "limit": 10,
        "offset": 0
      }
    }
    
    curl -X POST "https://df.apigw.ntruss.com/api/v2/notebooks/getList" \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu" \
    -H "x-ncp-apigw-timestamp: 1684749187130" \
    -H "x-ncp-apigw-signature-v2: rtHrKXxQaCKSVXanwMx3VKpQJmnPhATpLNsXXY3HvVs=" \
    -d "{ \"accountId\": \"2mUVZaHseGadiNFAg5MHjk\", \"paging\": { \"limit\": 10, \"offset\": 0 }}"
    

    Response examples

    • HTTP

      HTTP StatusDescription
      200OK
    • BASH

      {
          "success": true,
          "total": 1,
          "contents": [
            {
              "id": "7kHeVWhiRsxdRl0nXz04ri",
              "name": "df-notebook",
              "typeName": "Jupyter Lab",
              "state": "RUNNING",
              "vpcNo": 8717,
              "vpcName": "test-vpc",
              "subnetNo": 13594,
              "subnetName": "prisub-kr",
              "serverDesc": "vCPU 4EA, Memory 16GB, [HDD]Disk 50GB",
              "createdAt": "2023-05-22T16:53:30+09:00",
              "disabled": false
            }
          ]
      }
          ```
      
      

    Was this article helpful?

    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.