本接口名称为list_workspace。
名称 | 类型 | 是否必选 | 默认值 | 描述 |
|---|---|---|---|---|
params | dict | 是 | 无 | 具体参数解释见params |
名称 | 是否必选 | 说明 |
|---|---|---|
WorkspaceId | 否 | 工作区 ID，指定只返回特定的工作区。 |
WorkspaceName | 否 | 工作区名称，指定只返回特定的workspace |
PageNum | 否 | 分页页码。从 1 开始，默认为 1。 |
PageSize | 否 | 单页展示的工作区数量，最小值为 1，默认值为 10 。 |
ListScope | 否 | IncludeNotReadyWorkspaces表示包括处于非 Ready 状态的工作区（例如：创建中的工作区），IncludeDisabledWorkspaces表示包括被禁用的工作区。 |
StartPurchaseTime | 否 | 过滤的开始时间，时间格式符合 RFC3339 格式，如 2022-05-01T00:00:00+08:00。默认值为 720 天前。 |
EndPurchaseTime | 否 | 过滤的结束时间，时间格式符合 RFC3339 格式，如 2022-05-10T23:59:59+08:00。默认值为当前时间。 |
OrderType | 否 | 排序方式，取值范围如下：
|
OrderBy | 否 | 排序所依据的字段。默认为根据创建时间（CreatedAt）排序。 |
FuzzyWorkspaceName | 否 | 根据工作区名称进行模糊查找。 |
FuzzySearchContent | 否 | 根据工作区名称/ID/描述进行模糊查找。 |
名称 | 类型 | 描述 |
|---|---|---|
workspace_list | dict | 具体参数解释见WorkspaceList。 |
名称 | 类型 | 描述 |
|---|---|---|
Total | Int | 工作区总数。 |
Workspaces | struct | 工作区详情。具体参数解释见Workspace。 |
名称 | 类型 | 描述 |
|---|---|---|
Id | Int64 | 工作区 ID。 |
CreatedAt | time.Time | 工作区创建时间。 |
Name | String | 工作区名称。 |
Description | String | 工作区描述。 |
AccountID | Int64 | 主账号 ID。 |
UserID | Int64 | 子账号 ID。 |
AccountUserName | String | 主账号用户名。 |
RegionId | Int64 | 地区名称。 |
SpecIdList | []Int64 | 规格 ID 列表。 |
Status | String | 工作区状态。 |
Specification | struct | 具体参数解释见Specification。 |
HardwareSpecification | struct | 具体参数解释见HardwareSpecification。 |
名称 | 类型 | 描述 |
|---|---|---|
ID | Int64 | 工作区 ID。 |
StorageAvailable | Int64 | 可用存储空间。 |
StorageTotal | Int64 | 总存储空间。 |
ValidStartTime | time.Time | 工作区有效期开始时间。 |
名称 | 类型 | 描述 |
|---|---|---|
SupportCpu | String | 支持的 CPU 规格。 |
SupportGpu | String | 支持的 GPU 规格。 |
RegionName | String | 地区名称。 |
RegionId | Int64 | 地区 ID。 |
异常 | 说明 |
|---|---|
InternalError | 参数错误，如：PageNum/PageSize 为负数 |
BadRequest | StartPurchaseTime 或 EndPurchaseTime 格式错误 |