查询回调规则详情

查询一个回调规则。

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

调用前准备

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

请求参数

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

此接口没有额外请求参数。

成功响应

{
  "code": 0,
  "data": {
    "id": "rule_01",
    "workspace_id": "workspace_example",
    "provider": "wecom",
    "credential_ref": "cred_01",
    "name": "告警回调",
    "enabled": true,
    "priority": 0,
    "match": {
      "event_types": [
        "message"
      ]
    },
    "target_type": "agent_automation_task",
    "stop_after_match": false,
    "version": 1,
    "created_at": "2026-10-14T00:00:00Z",
    "updated_at": "2026-10-14T00:00:00Z",
    "target_config": {
      "automation_task_id": "task_01",
      "user_api_key_configured": true
    }
  }
}

字段

类型

说明

code

integer

请求处理成功时为 0。

data

object

响应数据。

data.id

string

回调规则 ID。

data.workspace_id

string

所属工作区 ID。

data.provider

string

提供商标识。

data.credential_ref

string

已保存凭据的引用，不是明文密钥。

data.name

string

名称。

data.description

string

说明。未设置时可省略。

data.enabled

boolean

是否启用。

data.priority

integer

匹配优先级。

data.match

object

匹配条件。

data.match.resource_kinds

string（字符串数组）

匹配的资源种类。数组内任一项可命中。未设置时可省略。

data.match.event_types

string（字符串数组）

匹配的事件类型。数组内任一项可命中。未设置时可省略。

data.match.event_actions

string（字符串数组）

匹配的事件动作。数组内任一项可命中。未设置时可省略。

data.match.field_equals

object

字段路径与匹配值的键值对。未设置时可省略。

data.target_type

string

回调目标类型，当前为 agent_automation_task。

data.target_config

object

回调目标配置及公开扩展字段。未设置时可省略。

data.target_config.automation_task_id

string

回调目标的自动化任务 ID。

data.target_config.user_api_key_configured

boolean

是否已保存用于目标调用的凭据。未设置时可省略。

data.stop_after_match

boolean

是否在命中后停止继续匹配。

data.version

integer

当前规则版本。更新时填入请求体的 version。

data.created_by

string

创建者标识。未设置时可省略。

data.updated_by

string

最近更新者标识。未设置时可省略。

data.created_at

string

创建时间，采用 RFC 3339 格式。

data.updated_at

string

最近更新时间，采用 RFC 3339 格式。

错误响应

{
  "code": 3,
  "message": "callback rule not found"
}

字段

类型

说明

code

integer

错误代码。

message

string

面向调用者的错误信息。
最后更新于