工作空间列表
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListWorkspaces | 要执行的操作,取值:ListWorkspaces。 |
Version | String | 是 | 2021-03-04 | API的版本,取值:2021-03-04。 |
PageNumber | Integer | 否 | 1 | 分页页码 |
PageSize | Integer | 否 | 10 | 分页页长 |
Filter | ListWorkspacesFilter | 否 | null | 筛选条件 |
SortBy | String | 否 | Name | 按字段排序,包括Name,CreateTime,UpdateTime,VisitTime,ID |
SortOrder | String | 否 | Asc | 指定排序顺序,包括Asc,Desc |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Integer | 100 | 总条数 |
PageSize | Integer | 10 | 分页页长 |
PageNumber | Integer | 1 | 分页页码 |
Items | Array of WorkspaceItem | [] | 工作空间列表 |
POST /?Action=ListWorkspaces&Version=2021-03-04 Content-Type:application/json { "PageNumber": 1, "PageSize": 10, "Filter": { "Keyword": "test", "IDs": ["wcxxxxxxxxxxxxxxxxxxx"], "IsPublic": false, "Labels": ["DNA"] }, "SortBy": "Name", "SortOrder": "Desc" }
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "202211302208xxxx", "Action": "ListWorkspaces", "Version": "2021-03-04", "Service": "bio", "Region": "cn-beijing" }, "Result": { "Items": [ { "ID": "wcxxxxxxxxxxxxxxxxxxx", "Name": "name", "Description": "description", "CreateTime": 1673525239, "UpdateTime": 1673525239, "OwnerName": "owner", "CoverDownloadURL": "https://bioos.tos-s3-cn-beijing.volces.com/template-cover/pic1.png?", "Role": "Admin", "S3Bucket": "bioos-wcxxxxxxxxxxxx", "PublicMeta": { "TosBucketTotalStorage": 20 }, "Labels": ["DNA"] } ], "PageNumber": 1, "PageSize": 10, "TotalCount": 100 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | ParamErr | <透传错误内容> | 参数错误 |
403 | ForbiddenErr | <透传错误内容> | 无权限 |
500 | InternalErr | <透传错误内容> | 内部错误 |