查询运行策略列表

查询工作区内的运行策略配置。

GET https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/runtime-policy-profiles

调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:要查询的工作区 ID,通过 X-Workspace-ID Header 传递,同时作为路径中的 workspace_id

路径参数

参数

类型

是否必填

说明

workspace_id

string

当前工作区 ID,必须与 X-Workspace-ID 一致。

查询参数

参数

类型

是否必填

说明

status

string

按策略状态筛选。

scope_type

string

按作用域类型筛选。

scope_ref

string

按作用域引用筛选。

query

string

按名称或相关文本查询。

limit

integer

返回数量上限。

offset

integer

返回偏移量。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/runtime-policy-profiles?limit=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

成功时返回 200data.items 为策略列表,data.totaldata.limitdata.offset 描述列表范围。

{
  "code": 0,
  "data": {
    "items": [
      {
        "id": "policy_01",
        "name": "默认运行限制",
        "status": "active",
        "scope_type": "workspace",
        "version": 1
      }
    ],
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

响应字段如下。

本文中,字段路径中的 [] 表示数组中的每一项。例如,items[].name 表示 items 数组中每一项的 name 字段。

字段

类型

说明

code

integer

成功时为 0

data.items[]

array

运行策略列表。

data.items[].id

string

运行策略 ID。

data.items[].name

string

策略名称和状态。

data.items[].status

string

策略名称和状态。

data.items[].scope_type

string

作用域类型和引用。

data.items[].scope_ref

string

作用域类型和引用。

data.items[].version

integer

策略版本。

data.total

integer

筛选结果总数、当前返回上限和偏移量。

data.limit

integer

筛选结果总数、当前返回上限和偏移量。

data.offset

integer

筛选结果总数、当前返回上限和偏移量。

错误响应

{
  "code": 2,
  "message": "运行策略参数无效"
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

2INVALID_ARGUMENT

工作区或筛选参数无效。

检查路径和查询参数。

401

6UNAUTHENTICATED

凭据缺失或无效。

检查 API Key。

403

5PERMISSION_DENIED

当前身份没有读取权限。

使用有权限的凭据,或联系管理员授权。

503

15UNAVAILABLE

运行策略服务不可用。

稍后重试。

后续操作

使用策略 ID 查询运行策略详情

最后更新于