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

ListNotebookServerImages

最近更新时间：2024.01.04 09:53:16

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

我的收藏
ListNotebookServerImages

列举Notebook Server镜像信息

接口说明

模块：Notebook Server管理
类型：open
场景：公有云

请求参数

参数名称类型是否必选示例值描述
ActionString是ListNotebookServerImages公共参数，本接口值：ListNotebookServerImages
VersionString是2021-03-04公共参数，本接口值：2021-03-04
ImageIDsArray of String否["1","2"]镜像ID，不传则返回所有
SourceString否official镜像来源 official,building
StatusString否pending镜像审核状态 pending,approve,building,failure
DisplayNameString否镜像名
ImageNameString否python:latest镜像地址
OwnByMeBoolean否false是否仅查看当前登录者所建镜像
PageNumberInteger否1分页页码
PageSizeInteger否10分页页长
SortByString否CreateTime按字段排序 取值有CreateTime ID
SortOrderString否Desc排序顺序

请求示例

POST /?Action=ListNotebookServerImages&Version=2021-03-04
Content-Type:application/json
{
    "ImageIDs": ["1","2"],
    "Source": "official",
    "Status": "pending",
    "DisplayName": "xxxxxxxx",
    "ImageName": "python:latest",
    "OwnByMe": false,
    "PageNumber": 1,
    "PageSize": 10,
    "SortBy": "CreateTime",
    "SortOrder": "Desc"
}

返回参数

参数名称类型示例值描述
ImagesArray of NotebookImage镜像信息

NotebookImage

参数名称类型示例值描述
ImageIDString1镜像 ID
DisplayNameStringminimal-notebook镜像名称(展示用)
ImageNameStringjupyter/minimal-notebook镜像名称
DescriptionStringdescription描述
AccountIDLong2100000000创建者主账户ID
UserIDLong123456创建者子用户ID
StatusStringpending镜像状态 pending,approve,building,failure
SourceStringofficial镜像来源 official,building
PackagesObject
Packages		工具包
BasicEnvArray of String["Python3.9.10", "R 4.1.2", "Julia 1.7.2"]基础环境参数，如python3.8等
ImageVersionString1.0.0镜像版本
CreateTimeObject
Timestamp		1680554098创建时间
UpdateTimeObject
Timestamp		1680554098更新时间

Packages

参数名称类型示例值描述
PipMap with keyType:string and valueType:string{"numpy":"1.22.2"}pip 工具包
CondaMap with keyType:string and valueType:string{"numpy":"1.22.2"}conda 工具包
RMap with keyType:string and valueType:string{"ggplot2":"3.4.4"}R 工具包
APTMap with keyType:string and valueType:string{"python3-dev":"1.22.2"}apt 工具包

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListNotebookServerImages",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "Images": [
            {
                "ImageID": "1",
                "DisplayName": "minimal-notebook",
                "ImageName": "jupyter/minimal-notebook",
                "Description": "description",
                "AccountID": 2100000000,
                "UserID": 123456,
                "Status": "pending",
                "Source": "official",
                "Packages": {
                    "Pip": ,
                    "Conda": ,
                    "R": ,
                    "APT": 
                },
                "BasicEnv": ["Python3.9.10", "R 4.1.2", "Julia 1.7.2"],
                "ImageVersion": "1.0.0",
                "CreateTime": ,
                "UpdateTime": 
            }
        ]
    }
}

错误码

HTTP 状态码错误码错误信息描述
400ParamErr<透传错误内容>参数错误
500InternalErr<透传错误内容>内部错误