getList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

作成した Notebookのリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
accountId	YES	String		- アカウント識別子 UUID(base62) - accountIdは Accountsの getList APIを通じて取得可能
paging	NO		- limitは 1以上でなければなりません。	- limit: 照会結果の最大個数。 - offset: スキップする結果の個数。

リクエストヘッダ

共通ガイド参照

リクエストボディ

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>

エラーコード

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

例

リクエスト例

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

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

この記事は役に立ちましたか?

What's Next

getDetail

リクエスト
エラーコード
例