---
orphan: true
---

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

# 查询工作空间名称

按已有数据分享关系中的工作空间 ID 查询名称。

```text
POST https://moi.matrixorigin.cn/newmoi/data-share/workspace-names
```

## 调用前准备

准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和要查询的工作空间 ID 列表。

## 请求体

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/data-share/workspace-names" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["'"$TARGET_WORKSPACE_ID"'"]
  }'
```

:::::
:::::{tab-item} 参数说明

::::{tab-set}
:::{tab-item} 参数

| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `ids` | array of string | 是 | 要查询名称的工作空间 ID 列表。 |

:::
::::

:::::
::::::
:::::::

## 成功响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workspaces": [
      {
        "id": "ws-02",
        "name": "分析工作区"
      }
    ]
  }
}
```

:::::
:::::{tab-item} 字段说明

::::{tab-set}
:::{tab-item} 通用字段

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data` | object | 响应数据。 |

:::
:::{tab-item} 工作区名称

下面表格展开响应示例中 `data` 对象；每一行是该对象的一个字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `workspaces` | array of object | 可解析的工作空间列表。 |

:::
:::{tab-item} 工作区列表

下面表格展开响应示例中 `data.workspaces` 数组的每一项；每一行是该数组项的一个字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `id` | string | 工作空间 ID。 |
| `name` | string | 工作空间名称。 |

:::
::::

:::::
::::::
:::::::

## 错误响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 错误代码。 |
| `msg` | string | 错误说明。 |
| `data` | null | 错误时为空。 |

:::::
::::::
:::::::