ListWorkspaces_人工智能平台 PAI - AI 工作空间_API文档-阿里云OpenAPI开发者门户

接口说明

您可以通过 option 参数指定不同的查询选项，来获取不同的工作空间相关信息。

请求速率为50/1(s)。更多流控信息，请前往配额中心查看

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

paiworkspace:ListWorkspaces	List	全部资源 *	无	无

GET /api/v1/workspaces HTTP/1.1

字段名称	字段详情
PageNumberinteger<int64>	工作空间列表的页码。起始值为 1，默认为 1。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1
PageSizeinteger<int32>	分页查询时设置的每页行数，默认为 20。示例值:20
SortBystring	分页查询时的排序字段，默认使用 GmtCreateTime。取值如下。展开详情示例值:GmtCreateTime
Orderstring	分页查询时，对指定的排序字段进行升序或降序。取值如下：展开详情示例值:ASC参考取值来源: CreateProductOrders
WorkspaceNamestring	工作空间名称。示例值:abc参考取值来源: GetWorkspace CreateWorkspace
ModuleListstring	逗号分割的模块列表。默认值：PAI。示例值:PAI
Statusstring	工作空间状态，目前支持如下值：展开详情示例值:ENABLED
Optionstring	选项，取值如下：展开详情示例值:GetWorkspaces
Verboseboolean	是否显示工作空间详细信息。取值如下：展开详情示例值:true
Fieldsstring	工作空间详情的返回字段列表。用于限定返回结果中的工作空间属性。展开详情示例值:Id
WorkspaceIdsstring	工作空间 ID 列表。多个工作空间 ID 用半角逗号（,）分隔。示例值:123,234参考取值来源: GetWorkspace CreateWorkspace
ResourceGroupIdstring	资源组 ID。如何查看资源组 ID，请参见查看资源组基本信息。示例值:rg-acfmwp7rky****

字段名称	字段详情
RequestIdstring	请求 ID。示例值:8D7B2E70-F770-505B-A672-09F1D8F2EC1E
Workspacesarray<object>	工作空间详情列表，当 Option 为 GetWorkspaces 时会返回该列表。
TotalCountinteger<int64>	符合查询条件的工作空间总数。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:1
ResourceLimitsobject	用户在一个工作空间内允许开通的资源类型和数量限制，当 Option 为 GetResourceLimits 时会返回该列表。展开详情示例值:{ "MaxCompute_share": 1, "MaxCompute_isolate": 1, "DLC_share": 1 }

	变更时间	变更内容概要	操作
	2025-01-23	新增请求参数ResourceGroupId 变更返回参数
	2021-03-02	变更返回参数