You need to enable JavaScript to run this app.
导航

ListNotebookServers - 查询全局NotebookServer列表

最近更新时间2024.04.23 14:21:25

首次发布时间2024.04.23 14:21:25

查询全局NotebookServer列表

请求参数

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

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

ListNotebookServers

要执行的操作,取值:ListNotebookServers。

Version
String

2021-03-04

API的版本,取值:2021-03-04。

Filter
ListNotebookServersFilter

null

筛选条件

PageNumber
Integer

1

分页页码

PageSize
Integer

10

分页页长

SortBy
String

OwnerName

按字段排序,取值有OwnerName StartTime StorageCapacity LastActivityTime

SortOrder
String

Desc

排序顺序,取值有Asc Desc

返回参数

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

参数
类型
示例值
描述
Items
Array of NotebookServerItem

[]

NotebookServer列表

TotalCount
Integer

10

总条数

请求示例

POST /?Action=ListNotebookServers&Version=2021-03-04
Content-Type:application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Status": ["spawn"],
        "WorkspaceID": "wcxxxxxxxxxxxxxxxxxxx",
        "UserID": 123456
    },
    "SortBy": "OwnerName",
    "SortOrder": "Desc"
}

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListNotebookServers",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Name": "name",
                "WorkspaceID": "wcxxxxxxxxxxxxxxxxxxx",
                "WorkspaceName": "name",
                "UserID": 123456,
                "OwnerName": "ownerName",
                "StorageCapacity": 107374182400,
                "Status": "spawn",
                "LastActivityTime": 1673525239,
                "StartTime": 1673525239,
                "Duration": 1
            }
        ],
        "TotalCount": 10
    }
}

错误码

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

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

参数错误

403
ForbiddenErr
<透传错误内容>

无权限

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

资源不存在

405
CanNotExecErr
<透传错误内容>

操作无法执行

500
InternalErr
<透传错误内容>

内部错误