MENU
      getList

        getList


        기사 요약

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

        생성한 Notebook의 목록을 조회합니다.

        요청

        요청 파라미터

        파라미터명필수 여부타입제약 사항설명
        accountIdYESString- 계정 식별자 UUID(base62)
        - accountId는 Accounts의 getList API를 통해서 획득 가능
        pagingNO- limit은 1이상 이어야합니다.- limit: 조회할 결과의 최대 개수
        - offset: 건너뛸 결과의 개수

        요청 헤더

        공통 가이드 참조

        요청 바디

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

        응답

        응답 바디

        • JSON
          {
            "contents": [
              {
                "createdAt": "2023-06-07T06:26:39.696Z",
                "id": "string",
                "name": "string",
                "serverDesc": "string",
                "state": "string",
                "subnetName": "string",
                "subnetNo": 0,
                "typeName": "string",
                "vpcName": "string",
                "vpcNo": 0
              }
            ],
            "message": "string",
            "success": true,
            "total": 0
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <GetNotebookListResponse>
              <contents>
                  <createdAt>2023-06-07T06:27:17.317Z</createdAt>
                  <id>string</id>
                  <name>string</name>
                  <serverDesc>string</serverDesc>
                  <state>string</state>
                  <subnetName>string</subnetName>
                  <subnetNo>0</subnetNo>
                  <typeName>string</typeName>
                  <vpcName>string</vpcName>
                  <vpcNo>0</vpcNo>
              </contents>
              <message>string</message>
              <success>true</success>
              <total>0</total>
          </GetNotebookListResponse>
          XML

        오류코드

        DataForest 개요 참조

        예시

        요청 예시

        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
          }
        }
        HTTP
        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 }}"
        Bash

        응답 예시

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

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

        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.