ListNotebookServerImages--生信操作系统Bio-OS-火山引擎

文档中心

立即注册

导航

ListNotebookServerImages

最近更新时间：2024.01.04 09:53:16首次发布时间：2023.07.11 20:57:50

ListNotebookServerImages

列举Notebook Server镜像信息

接口说明

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

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	ListNotebookServerImages	公共参数，本接口值：ListNotebookServerImages
Version	String	是	2021-03-04	公共参数，本接口值：2021-03-04
ImageIDs	Array of String	否	["1","2"]	镜像ID，不传则返回所有
Source	String	否	official	镜像来源 official,building
Status	String	否	pending	镜像审核状态 pending,approve,building,failure
DisplayName	String	否		镜像名
ImageName	String	否	python:latest	镜像地址
OwnByMe	Boolean	否	false	是否仅查看当前登录者所建镜像
PageNumber	Integer	否	1	分页页码
PageSize	Integer	否	10	分页页长
SortBy	String	否	CreateTime	按字段排序取值有CreateTime ID
SortOrder	String	否	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"
}

返回参数

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

NotebookImage

参数名称	类型	示例值	描述
ImageID	String	1	镜像 ID
DisplayName	String	minimal-notebook	镜像名称(展示用)
ImageName	String	jupyter/minimal-notebook	镜像名称
Description	String	description	描述
AccountID	Long	2100000000	创建者主账户ID
UserID	Long	123456	创建者子用户ID
Status	String	pending	镜像状态 pending,approve,building,failure
Source	String	official	镜像来源 official,building
Packages	Object Packages		工具包
BasicEnv	Array of String	["Python3.9.10", "R 4.1.2", "Julia 1.7.2"]	基础环境参数，如python3.8等
ImageVersion	String	1.0.0	镜像版本
CreateTime	Object Timestamp	1680554098	创建时间
UpdateTime	Object Timestamp	1680554098	更新时间

Packages

参数名称	类型	示例值	描述
Pip	Map with keyType:string and valueType:string	{"numpy":"1.22.2"}	pip 工具包
Conda	Map with keyType:string and valueType:string	{"numpy":"1.22.2"}	conda 工具包
R	Map with keyType:string and valueType:string	{"ggplot2":"3.4.4"}	R 工具包
APT	Map 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 状态码	错误码	错误信息	描述
400	ParamErr	<透传错误内容>	参数错误
500	InternalErr	<透传错误内容>	内部错误