You need to enable JavaScript to run this app.
导航
生信操作系统Bio-OS
  • 文档首页
    • /
  • 生信操作系统Bio-OS

GetNotebookServerSettings - 获取当前NotebookServer配置

最近更新时间：2024.04.23 14:21:06

首次发布时间：2023.07.11 20:57:50

我的收藏

获取当前NotebookServer配置

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

GetNotebookServerSettings

要执行的操作，取值：GetNotebookServerSettings。

Version
String
是

2021-03-04

API的版本，取值：2021-03-04。

WorkspaceID
String
是

wcxxxxxxxxxxxxxxxxxxx

工作空间ID

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
ResourceSize
String

small

资源规格，如果从未配置过返回空。包括small,middle.large等

ImageID
String

1

镜像ID，如果从未配置过返回空

MountTOSEnabled
Boolean

true

是否挂载tos桶

TempImageName
String

jupyter/minimal-notebook

临时镜像名，如果从未配置过返回空

StorageCapacity
Integer

21474836480

存储容量（byte）

请求示例

POST /?Action=GetNotebookServerSettings&Version=2021-03-04
Content-Type:application/json
{
    "WorkspaceID": "wcxxxxxxxxxxxxxxxxxxx"
}

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "GetNotebookServerSettings",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "ResourceSize": "small",
        "TempImageName": "jupyter/minimal-notebook",
        "MountTOSEnabled": true,
        "StorageCapacity": 107374182400
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
ParamErr
<透传错误内容>

参数错误

403
ForbiddenErr
<透传错误内容>

无权限

404
NotFoundErr
<资源类型>[<具体资源id>] not found

资源不存在

405
CanNotExecErr
<透传错误内容>

操作无法执行

500
InternalErr
<透传错误内容>

内部错误