文档首页/MaaS模型即服务/API参考/查询AI开发平台ModelArts-在线服务/获取工作空间信息
更新时间：2026-03-16 GMT+08:00
查看PDF
分享

获取工作空间信息

功能介绍

该API用于获取AI开发平台ModelArts-在线服务的工作空间信息。当创建自定义接入点的“source”参数选择“custom_from_modelarts_v2”时，查询infer_service_id。

接口约束

该功能仅支持“西南-贵阳一”区域。

URI

GET /v1/{project_id}/maas/services/workspace/{region_id}

表1 路径参数

参数

是否必选

参数类型

描述

project-id

是

String

参数解释：项目ID，获取方式请参见获取项目ID和名称。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

region_id

是

String

参数解释：AI开发平台ModelArts-在线服务的Region信息。获取方式请参见获取区域信息。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token。通过调用IAM服务的获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取方式请参见认证鉴权。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

Content-Type

是

String

参数解释：消息体的类型，固定为application/json。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

响应参数

表3 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：可以查询到的工作空间总数。

取值范围：不涉及。

count

Integer

参数解释：本次查询返回的工作空间数量。

取值范围：不涉及。

workspaces

Array[WorkspaceInfo]

参数解释：工作空间的信息。

取值范围：不涉及。

表4 WorkspaceInfo

参数

参数类型

描述

id

String

参数解释：工作空间ID。

取值范围：不涉及。

name

String

参数解释：工作空间名称。

取值范围：不涉及。

description

String

参数解释：工作空间的描述。

取值范围：不涉及。

owner

String

参数解释：工作空间的所有者。

取值范围：不涉及。

create_time

String

参数解释：创建时间。

取值范围：不涉及。

update_time

String

参数解释：更新时间。

取值范围：不涉及。

auth_type

String

参数解释：认证方式。

取值范围：不涉及。

表5 错误响应参数

参数

参数类型

描述

error_msg

String

参数解释：错误描述信息。

取值范围：不涉及。

error_code

String

参数解释：错误码，标识错误类型。

取值范围：不涉及。

响应示例

  • 成功响应，状态码：200。 
    {
    "total_count": 1,
    "count": 1,
    "workspaces": [
        {
            "id": "0",
            "name": "default",
            "description": "",
            "owner": "******",
            "create_time": 1680746333000,
            "update_time": 1764128642000,
            "auth_type": "public"
        }
    ]
}
  • 错误响应，状态码：400。 
    {
"error_msg": "Invalid token.",
"error_code": "ModelArts.0104"
}

状态码

请参见状态码。

错误码

请参见错误码。

相关文档