# 查询资源可展示的操作

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

查询指定 Catalog、数据库或卷在当前身份下可展示的操作。操作提示用于界面展示，实际执行时仍重新授权。

```text
POST https://api.moi.matrixorigin.cn/v5/catalog/allowed-actions
```

## 调用前准备

`BASE_URL` 使用产品 API 前缀 `https://api.moi.matrixorigin.cn/v5`；专有部署填写对应的产品 API 地址。

先从当前工作区的资源列表取得同一类型的资源 ID。准备具有相应读取权限的个人访问令牌和工作区 ID。`BASE_URL` 包含同环境产品前缀；`MOI_KEY` 和 `WORKSPACE_ID` 分别为产品凭据与工作区 ID。示例 ID 和数据均为占位值。

## 请求体

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
curl --fail-with-body -sS -X POST "$BASE_URL/catalog/allowed-actions" \
  -H "X-API-Key: $MOI_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{"resource_type": "catalog", "resource_ids": ["31", "32"]}'
```

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

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `resource_type` | string | 是 | 资源类型：catalog、database 或 volume。 |
| `resource_ids` | string[]（字符串数组） | 是 | 1–100 个同类型资源 ID。 |

ID 使用不重复的规范正整数十进制字符串，不带空格、正号或前导零。一次只查询请求中的候选，不展开子资源。

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

## 成功响应

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

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "items": [
      {
        "resource_id": "31",
        "allowed_actions": [
          "catalog.create_database"
        ]
      },
      {
        "resource_id": "32",
        "allowed_actions": []
      }
    ]
  }
}
```

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 OK。 |
| `msg` | string | 成功时为 OK。 |
| `data.items` | object[]（对象数组） | 候选资源及操作提示。 |
| `data.items[].resource_id` | string | 资源 ID。 |
| `data.items[].allowed_actions` | string[]（字符串数组） | 当前展示操作，可以为空。系统保留资源及共享订阅数据库可能屏蔽写操作。 |

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

## 错误响应

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

```json
{
  "code": "ErrParamInvalid",
  "msg": "示例错误信息"
}
```

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

| HTTP | code | 条件 |
| --- | --- | --- |
| 400 | ErrParamInvalid | 资源类型、ID 数量、格式或重复项无效。 |
| 503 | ErrCoreAuthorizeUnavailable | 权限投影不可用；保留实际错误，不能按空授权处理。 |

身份、权限及依赖失败以实际返回的 code、msg 和诊断字段为准。错误文案可随语言变化。

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