getList

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

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

요청

요청 파라미터

요청 헤더

공통 가이드 참조

요청 바디

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

응답

응답 바디

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

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

오류코드

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

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

응답 예시

• HTTP

  HTTP Status	Description
  200	OK

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