查询回调规则列表

查询工作区中的回调路由规则。

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/callback-rules

调用前准备

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

请求参数

输入示例

curl "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/callback-rules" -H "X-API-Key: $AI_STUDIO_API_KEY" -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

查询参数	类型	是否必填	说明
provider	string	否	提供商筛选。
credential_ref	string	否	凭据引用筛选。
enabled	boolean	否	是否启用。
limit	integer	否	默认 50，最大 200。
offset	integer	否	默认 0，负数按 0 处理。

使用 provider、credential_ref 和 enabled 筛选，使用 limit 和 offset 分页。limit 默认为 50，最大为 200。负的 offset 按 0 处理。

结果按 priority、id 升序排列，无匹配项时 items 为 []。

成功响应

响应示例

{
  "code": 0,
  "data": {
    "items": [],
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

字段说明

字段	类型	说明
code	integer	请求处理成功时为 0。
data	object	响应数据。
data.items	object（对象数组）	当前页回调规则。
data.items[].id	string	回调规则 ID。可用于查看、更新或删除该规则。
data.items[].workspace_id	string	所属工作区 ID。
data.items[].provider	string	提供商标识。
data.items[].credential_ref	string	已保存凭据的引用，不是明文密钥。
data.items[].name	string	名称。
data.items[].description	string	说明。未设置时可省略。
data.items[].enabled	boolean	是否启用。
data.items[].priority	integer	匹配优先级。
data.items[].match	object	匹配条件。
data.items[].match.resource_kinds	string（字符串数组）	匹配的资源种类。数组内任一项可命中。未设置时可省略。
data.items[].match.event_types	string（字符串数组）	匹配的事件类型。数组内任一项可命中。未设置时可省略。
data.items[].match.event_actions	string（字符串数组）	匹配的事件动作。数组内任一项可命中。未设置时可省略。
data.items[].match.field_equals	object	字段路径与匹配值的键值对。未设置时可省略。
data.items[].target_type	string	回调目标类型，当前为 agent_automation_task。
data.items[].target_config	object	回调目标配置及公开扩展字段。未设置时可省略。
data.items[].target_config.automation_task_id	string	接收回调的自动化任务 ID。
data.items[].target_config.user_api_key_configured	boolean	是否已保存用于目标调用的凭据。未设置时可省略。
data.items[].stop_after_match	boolean	是否在命中后停止继续匹配。
data.items[].version	integer	当前版本号。
data.items[].created_by	string	创建者标识。未设置时可省略。
data.items[].updated_by	string	最近更新者标识。未设置时可省略。
data.items[].created_at	string	创建时间，采用 RFC 3339 格式。
data.items[].updated_at	string	最近更新时间，采用 RFC 3339 格式。
data.total	integer	匹配规则总数。
data.limit	integer	本次返回的最大数量。
data.offset	integer	本次返回的起始位置。

错误响应

响应示例

{
  "code": 6,
  "message": "unauthenticated"
}

字段说明

字段	类型	说明
code	integer	错误代码。
message	string	面向调用者的错误信息。

最后更新于 2026 年 10 月 19 日