帮你快速理解、总结文档立即下载
文档中心>API 中心

数据结构

最近更新时间：2026-10-14 02:38:46
我的收藏

本页目录：

AIWorkbenchSREDigitalTwinTask

AI工作台SRE数字分身任务

被如下接口引用：DescribeAIWorkbenchSREDigitalTwinTaskList。

名称 类型 必选 描述
Name String 是 任务名称
示例值：报告生成
TaskType String 是 任务类型
示例值：custom
TaskConfig String 是 任务配置
示例值：{"uin": 1234}
ID Integer 否 唯一标识
示例值：1
CreatedAt String 否 创建时间
示例值：2025-07-11T10:50:14.872087+08:00
TwinID Integer 否 所属数字分身ID
示例值：2

AIWorkbenchSREDigitalTwinTaskList

AI工作台SRE数字分身任务列表

被如下接口引用：DescribeAIWorkbenchSREDigitalTwinTaskList。

名称 类型 描述
Tasks Array of AIWorkbenchSREDigitalTwinTask 任务列表
示例值：[{}]
Total Integer 任务总数
示例值：10

AIWorkbenchSREDigitalTwinWorkLog

AI工作台SRE数字分身工作日志

被如下接口引用：DescribeAIWorkbenchSREDigitalTwinWorkLogList。

名称 类型 描述
ID Integer 唯一标识符
示例值：1
CreatedAt String 创建时间
示例值：2025-07-11T10:50:14.872087+08:00
TwinID Integer 所属数字分身ID
示例值：1
TaskID Integer 所属数字分身任务ID
示例值：1
StartTime String 分析时间
示例值：2025-07-11T10:50:14.872087+08:00
Status String 分析状态
示例值：analyzing
Result String 分析结果摘要
示例值：分析结果：xxxx
TaskName String 所属任务名称
示例值：任务1
TaskType String 所属任务类型
示例值：custom

AIWorkbenchSREDigitalTwinWorkLogDetail

AI工作台SRE数字分身工作日志详细信息

被如下接口引用：DescribeAIWorkbenchSREDigitalTwinWorkLogDetail。

名称 类型 描述
Content String 工作日志详细内容
示例值：https://12345.cos.ap-guangzhou.myqcloud.com/report/12345/xxxx
TaskType String 工作日志任务类型
示例值：custom
DialogID Integer 工作日志相关对话ID
示例值：1

AIWorkbenchSREDigitalTwinWorkLogList

AI工作台SRE数字分身工作日志列表

被如下接口引用：DescribeAIWorkbenchSREDigitalTwinWorkLogList。

名称 类型 描述
WorkLogs Array of AIWorkbenchSREDigitalTwinWorkLog 工作日志列表
示例值：[{}]
Total Integer 总数
示例值：10

AgentInfo

Agent 信息

被如下接口引用：DescribeAIWorkbenchAgent, ListAIWorkbenchAgents, UpdateAIWorkbenchAgent。

名称 类型 描述
AgentId String

Agent ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：agt-****
Name String

Agent 名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：peter****
Description String

Agent 描述


注意：此字段可能返回 null，表示取不到有效值。
示例值：NewDesc
Category String

Agent 分类


注意：此字段可能返回 null，表示取不到有效值。
示例值：monitor
Status String

状态: draft/configured/running/standby/disabled


注意：此字段可能返回 null，表示取不到有效值。
示例值：running
SkillIds Array of String

关联技能 ID 列表


注意：此字段可能返回 null，表示取不到有效值。
示例值：["skill-xx"]
ResourceMapId String

关联的资源地图 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：map-id
MCPIds Array of String

关联的mcp id


注意：此字段可能返回 null，表示取不到有效值。
示例值：["mcp-xxx"]
CamTags Array of Tag

资源标签


注意：此字段可能返回 null，表示取不到有效值。
EnvVars Array of EnvVar

agent运行时所需环境变量


注意：此字段可能返回 null，表示取不到有效值。

AlarmLable

告警中的Label

被如下接口引用：DescribeAlarmNotifyHistories。

名称 类型 必选 描述
Name String 否 label name
示例值：key1
Value String 否 label value
示例值：value1

AlarmNotifyHistory

单个告警通知历史

被如下接口引用：DescribeAlarmNotifyHistories。

名称 类型 描述
NotifyId String

通知的唯一ID


示例值：d9729feb74992cc3482b350163a1a010_cdc
PolicyId String

告警策略ID


示例值：policy-123
SessionId String

告警周期iD


示例值：r_ad-123
NotifyTime Integer

通知时间 unix秒级时间戳


示例值：1732802380
TriggerTime Integer

触发时间 unix秒级时间戳


示例值：1732802380
TriggerLevel String

告警级别 None 非分级告警级别; Note 提示级别; Warn 严重级别; Serious 紧急级别


示例值：None
AlarmContent String

告警内容


示例值：content
AlarmObject String

告警对象


示例值：object
ChannelSet Array of String

本次告警通知涉及到的渠道合集


注意：此字段可能返回 null，表示取不到有效值。
示例值：["QCloudYehe_sms"]
ChannelsReceivers Array of ChannelsReceivers

渠道的接收人信息
PolicyName String

告警策略名称


示例值：默认告警策略
PromeInstanceID String

Prometheus实例ID, 仅当 MT_PROME 时有效


示例值：prom-123
PromeInstanceRegion String

Prometheus实例所在的地域, 仅当 MT_PROME 时有效


示例值：ap-guangzhou
Notices Array of NotifyRelatedNotice

通知模板相关的配置信息
TriggerStatus String

告警触发状态 Trigger 告警状态触发; Recovery 告警状态恢复


示例值：Trigger
PromeConsoleURL String

与当前Prometheus通知历史相关控制台页面地址，仅当 MR_PROME 时有效


示例值：https://console.cloud.tencent.com/monitor/prometheus/detail/prom-h72esnds/alertRule?rid=19&policyId=alert-xx
Labels Array of AlarmLable

告警的lable
ReceiverGroups Array of ReceiverGroup

该条通知实际执行的接收人/组明细。一条元素对应通知模板里的一条渠道发送规则


注意：此字段可能返回 null，表示取不到有效值。

ArtifactInfo

产物实体

被如下接口引用：DescribeAIWorkbenchArtifact, ListAIWorkbenchArtifacts。

名称 类型 描述
ArtifactId String

产物 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：a3***1b2
Name String

产物名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：c**s.j**n
MimeType String

物理类型


注意：此字段可能返回 null，表示取不到有效值。
示例值：application/json
SizeBytes Integer

文件大小(字节)


注意：此字段可能返回 null，表示取不到有效值。
示例值：646
IsGlobal Boolean

是否公共


注意：此字段可能返回 null，表示取不到有效值。
示例值：true
CreatedAt Integer

创建时间 Unix 秒时间戳


注意：此字段可能返回 null，表示取不到有效值。
示例值：0
UpdatedAt Integer

修改时间


注意：此字段可能返回 null，表示取不到有效值。
示例值：0
AgentId String

产生该制品的 Agent ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：agt-****
SkillId String

产生该制品的 Skill ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：skl-****
StoragePath String

用于解析调用下载接口


注意：此字段可能返回 null，表示取不到有效值。
示例值：sandbox_file://ses-****/**-20260804.md
SourceType String

来源类型


注意：此字段可能返回 null，表示取不到有效值。
示例值：session
SourceName String

来源名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：分析近3天告警历史
ExecutionSummary String

预览摘要


注意：此字段可能返回 null，表示取不到有效值。
示例值：本任务分析了资源地图xyytest（coll-pvgzghqj）内3个CVM实例近1天的告警历史分布。通过按实例逐一调用DescribeAlarmHistories精确查询，确认3个实例报告已生成并输出至制品目录。

ChannelContent

消息正文

被如下接口引用：DescribeAlarmNotifyHistories。

名称 类型 必选 描述
SubChannel String 否

本段正文所属的渠道或子渠道全名

枚举值：

  • QCloudYehe_site： 腾讯云野鹤，站内信
  • QCloudYehe_email： 腾讯云野鹤，电子邮件
  • QCloudYehe_sms： 腾讯云野鹤，短信
  • QCloudYehe_wechat： 腾讯云野鹤，微信
  • QCloudYehe_voice： 腾讯云野鹤，语音
  • QCloudYehe_qywx： 腾讯云野鹤，企业微信
  • QCloudYehe_andon： 腾讯云野鹤，安灯
  • TOF_weWorkMessage： TOF，企业微信消息
  • TOF_email： TOF，企业邮箱
  • TOF_phoneCall： TOF，电话
  • WeWork： 企业微信机器人
  • WebHook： 自定义 WebHook
  • FeiShu： 飞书
  • DingDing： 钉钉
  • Slack： Slack
  • GoogleChat： Google Chat
  • Teams： Teams
  • TeamsWorkflow： Teams Workflow
  • PagerDuty： PagerDuty
  • CLS： 日志服务 CLS
  • AS： 弹性伸缩
  • TCSYehe： TCS 野鹤。正文的 SubChannel 取渠道名本身
  • SCF： 云函数。不返回 Contents

注意：此字段可能返回 null，表示取不到有效值。
示例值：QCloudYehe_email
Content String 否

该渠道实际发送的消息正文，由 Ark 按写时捕获的内容还原


注意：此字段可能返回 null，表示取不到有效值。
示例值：【TCOP】【告警触发】云产品告警详情页测试尊敬的腾讯云用户，您好！ 您的腾讯云账号（账号ID：1500000686，昵称：...

ChannelsReceivers

接受人详情信息和通知详情页展示

被如下接口引用：DescribeAlarmNotifyHistories。

名称 类型 必选 描述
ChannelName String 否

通知渠道名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：叮叮
Receivers Array of String 否

接收者


注意：此字段可能返回 null，表示取不到有效值。
示例值：["908395238"]
SendStatus String 否

发送结果,0-无效,1-成功,2-失败,3-无需发送


注意：此字段可能返回 null，表示取不到有效值。
示例值：0
SendStatusCode String 否

参数定义 渠道返回的原始状态码。


注意：此字段可能返回 null，表示取不到有效值。
示例值：OK_0
SendTime Integer 否

Ark 发起该渠道调用的时间

单位：Unix 秒级时间戳


注意：此字段可能返回 null，表示取不到有效值。
示例值：1791445043
SubChannels Array of String 否

该渠道本次实际发送的子渠道全名，格式为 父渠道_子渠道

枚举值：

  • QCloudYehe_site： 腾讯云野鹤，站内信
  • QCloudYehe_email： 腾讯云野鹤，电子邮件
  • QCloudYehe_sms： 腾讯云野鹤，短信
  • QCloudYehe_wechat： 腾讯云野鹤，微信
  • QCloudYehe_voice： 腾讯云野鹤，语音
  • QCloudYehe_qywx： 腾讯云野鹤，企业微信
  • QCloudYehe_andon： 腾讯云野鹤，安灯
  • TOF_weWorkMessage： TOF，企业微信消息
  • TOF_email： TOF，企业邮箱
  • TOF_phoneCall： TOF，电话

注意：此字段可能返回 null，表示取不到有效值。
示例值：["QCloudYehe_email"]
ExecDetail String 否

该渠道本次执行情况的文字描述


注意：此字段可能返回 null，表示取不到有效值。
示例值：ok
RealDeliverStatus String 否

短信真实投递状态，来自野鹤 smsStatus 回调的 reportStatus 原值

枚举值：

  • SUCCESS： 短信已真实送达
  • FAIL： 短信真实投递失败，失败原因见 RealDeliverErrMsg

注意：此字段可能返回 null，表示取不到有效值。
示例值：SUCCESS
RealDeliverTime String 否

用户真实收到短信的时间，取野鹤回调 userReceiverTime 原文字符串

参数格式：YYYY-MM-DD HH:mm:ss


注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-08-05 18:04:46
RealDeliverErrMsg String 否

短信真实投递回执中的结果码，取野鹤回调 errmsg 原值


注意：此字段可能返回 null，表示取不到有效值。
示例值：DELIVRD
Contents Array of ChannelContent 否

该渠道下各子渠道的消息正文明细


注意：此字段可能返回 null，表示取不到有效值。

ContentBlockInfo

每个 ContentBlockInfo 对应下游 ContentBlock 转换而来的一个 AGUI 事件。

被如下接口引用：ListAIWorkbenchMessages。

名称 类型 必选 描述
Type String 否

类型


示例值：TOOL_CALL_RESULT
Data String 否

数据内容


示例值：{"messageId":"ent-l0fj1miwg6ty","role":"assistant","timestamp":1786516818000,"type":"TEXT_MESSAGE_START"}

DingDingRobotNoticeTmpl

钉钉机器人内容模板配置

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
ContentTmpl String 是 内容模板
示例值：告警通知模板{{.PolicyName}}
TitleTmpl String 否 标题模板
示例值：标题{{.PolicyName}}

DingDingRobotNoticeTmplMatcher

钉钉机器人通知模板的匹配器

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
MatchingStatus Array of String 是 匹配状态 Invalid;
Trigger 告警触发; Recovery 告警恢复
示例值：Trigger
Template DingDingRobotNoticeTmpl 是 模板配置

DispenseCondition

转发过滤条件信息

被如下接口引用：CreateDispenseExternalRule, DescribeDispenseExternalRule, DescribeDispenseExternalRuleList, ModifyDispenseExternalRule。

名称 类型 必选 描述
ExtMetric String 否 对外指标名
示例值：InvisibleMsgNum
DispenseFilters Array of DispenseFilter 否 过滤条件表
ConditionId Integer 否 过滤条件id
示例值：条件id

DispenseFilter

过滤表

被如下接口引用：CreateDispenseExternalRule, ModifyDispenseExternalRule。

名称 类型 必选 描述
Key String 否 维度名称
示例值：uuid
Values Array of String 否 维度值列表
示例值：["abc","def"]
Expression String 否 表示式
示例值：equal或者in

DispenseGlobalTag

全局维度

被如下接口引用：CreateDispenseExternalRule, ModifyDispenseExternalRule。

名称 类型 必选 描述
Key String 否 维度key
Value String 否 维度值

DispenseRegion

转发地域信息

被如下接口引用：DescribeDispenseRegion。

名称 类型 必选 描述
Region String 否 地域缩写
RegionCnName String 否 地域中文名
RegionEnName String 否 地域英文名
RuleNumber Integer 否 规则数量

EnvEntry

环境变量entry

被如下接口引用：CreateAIWorkbenchAgent, DescribeAIWorkbenchAgent, ListAIWorkbenchAgents, UpdateAIWorkbenchAgent。

名称 类型 必选 描述
Value String 否

环境变量value


注意：此字段可能返回 null，表示取不到有效值。
示例值：sk-**
Sensitive Boolean 否

是否脱敏


注意：此字段可能返回 null，表示取不到有效值。
示例值：true

EnvVar

agent运行时所需环境变量

被如下接口引用：CreateAIWorkbenchAgent, DescribeAIWorkbenchAgent, ListAIWorkbenchAgents, UpdateAIWorkbenchAgent。

名称 类型 必选 描述
Key String 否

环境变量key


注意：此字段可能返回 null，表示取不到有效值。
示例值：API_KEY
Value EnvEntry 否

环境变量value


注意：此字段可能返回 null，表示取不到有效值。

ExecutionInfo

执行记录实体

被如下接口引用：DescribeAIWorkbenchExecution, ListAIWorkbenchExecutions。

名称 类型 描述
Name String

任务名


示例值：基础报告生成测试
TaskId String

任务 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：tsk-****
ExecutionId String

执行 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：exe-****
AgentId String

Agent ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：agt-****
SessionId String

会话 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：ses-****
TriggerType String

触发类型: manual / cron / webhook


注意：此字段可能返回 null，表示取不到有效值。
示例值：manual
Status String

状态: pending/running/completed/failed/timeout/cancelled


注意：此字段可能返回 null，表示取不到有效值。
示例值：completed
Summary String

执行摘要


注意：此字段可能返回 null，表示取不到有效值。
示例值：任务为基于用户提供的固定内容生成每日APM告警分析报告。助手已确认任务要求，并等待用户提供报告正文内容，尚未生成最终报告。目前无异常，处于等待输入状态。
DurationMs Integer

执行耗时(毫秒)


注意：此字段可能返回 null，表示取不到有效值。
示例值：18948

ExtMetric

对外指标

被如下接口引用：DescribeDispenseExternalRule, DescribeDispenseExternalRuleList, DescribeExtMetric。

名称 类型 必选 描述
MetricName String 否 指标名
注意：此字段可能返回 null，表示取不到有效值。
MetricCName String 否 中文指标名
注意：此字段可能返回 null，表示取不到有效值。
CNMeaning String 否 中文含义
注意：此字段可能返回 null，表示取不到有效值。
EnMeaning String 否 英文含义
注意：此字段可能返回 null，表示取不到有效值。
Unit String 否 单位
注意：此字段可能返回 null，表示取不到有效值。
DimensionFlag Boolean 否 是否配置对外维度

FeiShuRobotNoticeTmpl

飞书机器人内容模板配置

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
ContentTmpl String 是

内容模板


示例值：告警通知模板{{.PolicyName}}
TitleTmpl String 否

标题模板


示例值：标题{{.PolicyName}}
TitleColor RobotNoticeTitleColor 否

通知内容模版标题自定义颜色

FeiShuRobotNoticeTmplMatcher

飞书机器人通知模板的匹配器

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
MatchingStatus Array of String 是 匹配状态 Invalid;
Trigger 告警触发; Recovery 告警恢复
示例值：Trigger
Template FeiShuRobotNoticeTmpl 是 模板配置

GoogleChatRobotNoticeTmpl

Google Chat 机器人内容模板配置

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
ContentTmpl String 是 内容模板
示例值：IyMjIFnt7Sku

GoogleChatRobotNoticeTmplMatcher

Google Chat 机器人通知模板的匹配器

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
MatchingStatus Array of String 是 匹配状态 Invalid;
Trigger 告警触发; Recovery 告警恢复
示例值：["Trigger"]
Template GoogleChatRobotNoticeTmpl 是 模板配置

InstructionConfig

分身提示词配置

被如下接口引用：CreateAIWorkbenchAgent, UpdateAIWorkbenchAgent。

名称 类型 必选 描述
RolePosition String 否

角色定义


示例值：腾讯云可观测平台用户的运维数字分身
CoreDuty String 否

核心职责


示例值：线上故障应急响应：快速定位异常根因
CoreTruths String 否

核心原则


示例值：主动前置不被动：不等你追问，预判需求、提前行动
Vibe String 否

风格约束


示例值：直白接地气：拒绝黑话堆砌
Boundaries String 否

注意事项


示例值：不擅自执行生产环境高危操作

KafkaConnectivity

kafka连通性

被如下接口引用：DescribeKafka。

名称 类型 必选 描述
Region String 否 地域
示例值：gz
Result Boolean 否 连通
示例值：true

MCPInfo

MCP 实体

被如下接口引用：ListAIWorkbenchMCPs。

名称 类型 描述
MCPId String

mcp的ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：mcp-****
Name String

MCP 名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：tcop-cls-mcp
Description String

MCP 描述


注意：此字段可能返回 null，表示取不到有效值。
示例值：mcp的描述信息
Url String

MCP URL


注意：此字段可能返回 null，表示取不到有效值。
示例值：www.testmcp.com
Transport String

传输协议: sse / streamable_http / stdio


注意：此字段可能返回 null，表示取不到有效值。
示例值：streamable_http
AuthType String

认证类型: none / bearer / basic / api_key


注意：此字段可能返回 null，表示取不到有效值。
示例值：aksk
AuthSecret String

认证密钥(响应时脱敏)


注意：此字段可能返回 null，表示取不到有效值。
示例值：***vfsz
Timeout Integer

超时时间(秒)


注意：此字段可能返回 null，表示取不到有效值。
示例值：20
RetryCount Integer

重试次数


注意：此字段可能返回 null，表示取不到有效值。
示例值：0
Headers String

请求头 JSON


注意：此字段可能返回 null，表示取不到有效值。
示例值：***tX"}
Enabled Boolean

是否启用


注意：此字段可能返回 null，表示取不到有效值。
示例值：true

MessageInfo

消息实体

被如下接口引用：ListAIWorkbenchMessages。

名称 类型 描述
EntryId String

实体id


注意：此字段可能返回 null，表示取不到有效值。
示例值：ent-****
SessionId String

会话 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：ses-****
Role String

角色: user / assistant


注意：此字段可能返回 null，表示取不到有效值。
示例值：user
Content String

消息内容


注意：此字段可能返回 null，表示取不到有效值。
示例值：分析云服务器最近三天的告警历史分布
Status String

状态


示例值：completed
ContentBlocks Array of ContentBlockInfo

块内容


注意：此字段可能返回 null，表示取不到有效值。

NoticeContentTmpl

自定义通知内容模板

被如下接口引用：DescribeNoticeContentTmpl。

名称 类型 必选 描述
TmplID String 否

自定义通知内容模板id，唯一id


注意：此字段可能返回 null，表示取不到有效值。
示例值：tmpl-123
TmplName String 否

自定义通知内容模板名


注意：此字段可能返回 null，表示取不到有效值。
示例值：name
TmplContents NoticeContentTmplItem 否

通知内容


注意：此字段可能返回 null，表示取不到有效值。
CreateTime Integer 否

Unix时间戳，秒


注意：此字段可能返回 null，表示取不到有效值。
示例值：1729655205
UpdateTime Integer 否

Unix时间戳，秒


注意：此字段可能返回 null，表示取不到有效值。
示例值：1729655205
LastModifier String 否

最后修改人


注意：此字段可能返回 null，表示取不到有效值。
示例值：1500000000
Creator String 否

创建人


注意：此字段可能返回 null，表示取不到有效值。
示例值：1500000000
MonitorType String 否

监控类型


示例值：MT_QCE
TmplLanguage String 否

模板语言 en/zh


示例值：zh

NoticeContentTmplBindPolicyCount

通知内容模板绑定告警策略数量

被如下接口引用：DescribeNoticeContentTmpl。

名称 类型 必选 描述
NoticeContentTmplID String 否 通知内容模板ID
示例值：tmpl-xxx
BindCount Integer 否 绑定告警策略数量
示例值：1

NoticeContentTmplItem

内容通知模板元素

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
QCloudYehe Array of QCloudYeheNoticeTmplMatcher 否

官网通知渠道配置


注意：此字段可能返回 null，表示取不到有效值。
WeWorkRobot Array of WeWorkRobotNoticeTmplMatcher 否

企业微信机器人通知渠道配置


注意：此字段可能返回 null，表示取不到有效值。
DingDingRobot Array of DingDingRobotNoticeTmplMatcher 否

钉钉机器人通知渠道配置


注意：此字段可能返回 null，表示取不到有效值。
FeiShuRobot Array of FeiShuRobotNoticeTmplMatcher 否

飞书机器人通知渠道配置


注意：此字段可能返回 null，表示取不到有效值。
Webhook Array of WebhookNoticeTmplMatcher 否

自定义Webhook通知渠道配置


注意：此字段可能返回 null，表示取不到有效值。
TeamsRobot Array of TeamsRobotNoticeTmplMatcher 否

Teams机器人通知渠道配置


注意：此字段可能返回 null，表示取不到有效值。
PagerDutyRobot Array of PagerDutyRobotNoticeTmplMatcher 否

PagerDutyRobot机器人通知渠道配置


注意：此字段可能返回 null，表示取不到有效值。
GoogleChatRobot Array of GoogleChatRobotNoticeTmplMatcher 否

GoogleChat
SlackRobot Array of SlackRobotNoticeTmplMatcher 否

Slack
TeamsWorkflowRobot Array of TeamsWorkflowRobotNoticeTmplMatcher 否

Teams 工作流渠道

NotifyRelatedNotice

通知历史中关联的通知模板信息

被如下接口引用：DescribeAlarmNotifyHistories。

名称 类型 描述
NoticeId String 通知模板ID
示例值：notice-123
NoticeName String 通知模板的名称
示例值：默认通知模板

PageByNoParams

分页请求参数

被如下接口引用：DescribeAlarmNotifyHistories。

名称 类型 必选 描述
PerPage Integer 否

每个分页的数量是多少


注意：此字段可能返回 null，表示取不到有效值。
示例值：19
PageNo String 否

第几个分页，从1开始


注意：此字段可能返回 null，表示取不到有效值。
示例值：1

PageByNoResult

分页结果参数

被如下接口引用：DescribeAlarmNotifyHistories。

名称 类型 必选 描述
TotalCount Integer 否 总共有多少数据
注意：此字段可能返回 null，表示取不到有效值。
示例值：12
TotalPage Integer 否 总共有多少个分页
注意：此字段可能返回 null，表示取不到有效值。
示例值：12
CurrentPageNo Integer 否 当前的分页号
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
End Boolean 否 是否遍历到末尾
示例值：0

PageByNumParams

按第几页进行分页的入参

被如下接口引用：ListAIWorkbenchResourceInstances。

名称 类型 必选 描述
PerPage Integer 否

每个分页的数量


示例值：20
PageNo Integer 否

第几个分页，从1开始


示例值：1

PageByNumResult

分页结果参数

被如下接口引用：ListAIWorkbenchAgents, ListAIWorkbenchArtifacts, ListAIWorkbenchExecutions, ListAIWorkbenchMCPs, ListAIWorkbenchResourceInstances, ListAIWorkbenchResourceMaps, ListAIWorkbenchSessions, ListAIWorkbenchSkills, ListAIWorkbenchTasks。

名称 类型 必选 描述
TotalCount Integer 否

总共有多少数据


注意：此字段可能返回 null，表示取不到有效值。
示例值：178
TotalPage Integer 否

总共有多少个分页


注意：此字段可能返回 null，表示取不到有效值。
示例值：20
CurrentPageNo Integer 否

当前的分页号


注意：此字段可能返回 null，表示取不到有效值。
示例值：1

PagerDutyRobotNoticeTmpl

告警通知自定义PagerDutyRobot内容模板

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
Body String 否 请求体模板 仅支持json
示例值：e3sibmFtZSI6ICJ7ey5zdGFmZn19In0=
Headers Array of PagerDutyRobotNoticeTmplHeader 否 请求头 暂时未支持
注意：此字段可能返回 null，表示取不到有效值。
TitleTmpl String 否 标题模板
示例值：标题

PagerDutyRobotNoticeTmplHeader

告警通知自定义PagerDutyRobot模板中的请求体头部描述

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
Key String 是 http请求中header的key
示例值：key
Values Array of String 是 http请求中header的value
示例值：["v1", "v2"]

PagerDutyRobotNoticeTmplMatcher

告警通知自定义PagerDutyRobot的通知内容模板匹配器

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
MatchingStatus Array of String 否 匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复
示例值：Trigger
Template PagerDutyRobotNoticeTmpl 否 自定义PagerDutyRobot内容模板

Producer

转发目标对象信息

被如下接口引用：CreateDispenseExternalRule, DescribeDispenseExternalRule, DescribeDispenseExternalRuleList, ModifyDispenseExternalRule。

名称 类型 必选 描述
ProtocolType Integer 是 转发协议类型，0-stormRetPb, 1-tcbDispensePb, 2-stormRetJson, 3-ADPPb(废弃)，4-中台pb
注意：此字段可能返回 null，表示取不到有效值。
Type String 是 目标类型
注意：此字段可能返回 null，表示取不到有效值。
Brokers String 是 转发kafka地址
注意：此字段可能返回 null，表示取不到有效值。
Topic String 是 转发kafka topic
注意：此字段可能返回 null，表示取不到有效值。
Merge Integer 否 是否合并指标,默认是1，合并
GlobalTags Array of DispenseGlobalTag 否 全局维度组
DefaultTags Array of String 否 默认维度组，只提供维度即可
Username String 否 Kafka用户名
Password String 否 Kafka密码

QCloudYeheNoticeTmpl

官网通知内容模板

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
Email QCloudYeheNoticeTmplItem 否 邮件通知渠道
QYWX QCloudYeheNoticeTmplItem 否 企业微信通知渠道
SMS QCloudYeheNoticeTmplItem 否 短信通知渠道
Voice QCloudYeheNoticeTmplItem 否 语音通知渠道
WeChat QCloudYeheWeChatNoticeTmplItem 否 微信通知渠道
Site QCloudYeheNoticeTmplItem 否 站内信通知渠道
Andon QCloudYeheNoticeTmplItem 否 安灯通知渠道

QCloudYeheNoticeTmplItem

官网通知内容模板元素

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
ContentTmpl String 是 内容模板
示例值：告警通知模板{{.PolicyName}}
TitleTmpl String 否 标题
示例值：告警通知模板{{.PolicyName}}

QCloudYeheNoticeTmplMatcher

官网内容通知模板的匹配器

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
MatchingStatus Array of String 是 匹配状态 Invalid;
Trigger 告警触发; Recovery 告警恢复
示例值：Trigger
Template QCloudYeheNoticeTmpl 是 模板配置

QCloudYeheWeChatNoticeTmplItem

官网通知内容模板元素

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
AlarmContentTmpl String 否 告警内容模板
示例值：{{.content}}
AlarmObjectTmpl String 否 告警对象模板
示例值：{{.object}}
AlarmRegionTmpl String 否 告警地域模板
示例值：{{.region_fmt}}
AlarmTimeTmpl String 否 告警时间模板
示例值：触发时间{{.first_trigger_time_fmt}}

ReceiverGroup

承载消息接收人/组明细

被如下接口引用：DescribeAlarmNotifyHistories。

名称 类型 描述
ReceiverType String

本条发送规则的接收者类型

枚举值：

  • UIDs： 按用户 UID
  • UINs： 按账号 UIN
  • Group： 按用户分组。ReceiverIds 为分组 ID
  • Oncall： 按值班表，且未被发送时的真实接收人覆盖
  • RtxName： 发送时解析出的员工 RTX 英文名

注意：此字段可能返回 null，表示取不到有效值。
示例值：UIDs
ReceiverIds Array of String

本条规则配置的原始接收者 ID 列表。具体是哪一种 ID，由 ReceiverType 决定


注意：此字段可能返回 null，表示取不到有效值。
示例值：["906911493"]
Names Array of String

接收者展示名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：["log_test2"]
MemberIds Array of String

用户分组展开后的成员用户 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：["906911493"]
WeekDay Array of Integer

该规则允许通知的星期。语义与 time.Weekday 一致

枚举值：

  • 0： 周日
  • 1： 周一
  • 2： 周二
  • 3： 周三
  • 4： 周四
  • 5： 周五
  • 6： 周六

注意：此字段可能返回 null，表示取不到有效值。
示例值：[0]
DayStartSeconds Integer

通知时段相对当日零点的秒数偏移，需配合 TimeZoneName 解读

单位：秒


注意：此字段可能返回 null，表示取不到有效值。
示例值：0
DayEndSeconds Integer

通知时段相对当日零点的秒数偏移，需配合 TimeZoneName 解读

单位：秒


注意：此字段可能返回 null，表示取不到有效值。
示例值：86399
TimeZoneName String

DayStartSeconds、DayEndSeconds 所属时区


注意：此字段可能返回 null，表示取不到有效值。
示例值：Asia/Shanghai
ChannelNames Array of String

该规则实际发送的接收渠道全名列表

枚举值：

  • QCloudYehe_site： 腾讯云野鹤，站内信
  • QCloudYehe_email： 腾讯云野鹤，电子邮件
  • QCloudYehe_sms： 腾讯云野鹤，短信
  • QCloudYehe_wechat： 腾讯云野鹤，微信
  • QCloudYehe_voice： 腾讯云野鹤，语音
  • QCloudYehe_qywx： 腾讯云野鹤，企业微信
  • QCloudYehe_andon： 腾讯云野鹤，安灯
  • TOF_weWorkMessage： TOF，企业微信消息
  • TOF_email： TOF，企业邮箱
  • TOF_phoneCall： TOF，电话
  • WeWork： 企业微信机器人
  • WebHook： 自定义 WebHook
  • FeiShu： 飞书
  • DingDing： 钉钉
  • Slack： Slack
  • GoogleChat： Google Chat
  • Teams： Teams
  • TeamsWorkflow： Teams Workflow
  • PagerDuty： PagerDuty
  • CLS： 日志服务 CLS
  • AS： 弹性伸缩
  • TCSYehe： TCS 野鹤。正文的 SubChannel 取渠道名本身
  • SCF： 云函数。不返回 Contents

注意：此字段可能返回 null，表示取不到有效值。
示例值：["QCloudYehe_email"]

ResourceInstance

资源实例

被如下接口引用：ListAIWorkbenchResourceInstances。

名称 类型 必选 描述
Id String 否

实例 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：doc-****
Service String 否

服务名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：TCOP
Region String 否

地域


注意：此字段可能返回 null，表示取不到有效值。
示例值：ap-guangzhou
IsReady Boolean 否

是否就绪


注意：此字段可能返回 null，表示取不到有效值。
示例值：true

ResourceMapInfo

资源地图实体

被如下接口引用：ListAIWorkbenchResourceMaps。

名称 类型 描述
ResourceMapId String

资源地图 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：coll-****
Name String

资源地图名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：*-test-**
Description String

资源地图描述


注意：此字段可能返回 null，表示取不到有效值。
示例值：desc
InstanceCount Integer

总实例数


注意：此字段可能返回 null，表示取不到有效值。
示例值：42

RobotNoticeTitleColor

告警通知内容模版自定义标题颜色

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
Default String 否

通知内容模版自定义标题颜色默认颜色


示例值：violet
Rules Array of RobotNoticeTitleColorRules 否

通知内容模版自定义标题颜色规则，label 匹配设置颜色

RobotNoticeTitleColorRules

告警通知内容模版自定义标题颜色 key-value 匹配规则

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
Key String 是

通知内容模版自定义颜色 Label 匹配的 Key


示例值：current_level
Value String 是

通知内容模版自定义颜色 Label 匹配的 Value


示例值：Serious
Color String 是

通知内容模版自定义颜色


示例值：wathet

Rule

转发规则

被如下接口引用：DescribeDispenseExternalRule, DescribeDispenseExternalRuleList。

名称 类型 描述
RuleId Integer 规则Id
Name String 规则名称
ExtNamespace String 对外namespace
ExtMetric Array of ExtMetric 对外指标列表
Producer Producer 输出信息
UpdateTime Integer 更新时间
Status Integer 规则触发状态
Period Array of Integer 指标粒度周期
注意：此字段可能返回 null，表示取不到有效值。
DispenseConditions Array of DispenseCondition 转发过滤条件
注意：此字段可能返回 null，表示取不到有效值。
DispenseRegions Array of String 转发地域列表

SessionInfo

会话实体

被如下接口引用：DescribeAIWorkbenchSession, ListAIWorkbenchSessions。

名称 类型 描述
SessionId String

会话 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：ses-****
AgentId String

Agent ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：agt-****
Title String

会话标题


注意：此字段可能返回 null，表示取不到有效值。
示例值：任务目标：
分析指定账号下近N天的告警历史分布情况，识别频繁告警的对象并进一步获取详细信息进行摘要分
Status String

状态: active / archived / deleted


注意：此字段可能返回 null，表示取不到有效值。
示例值：active
TaskId String

如果该会话由任务触发，则携带触发其会话的任务ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：tsk-****

SkillInfo

技能实体

被如下接口引用：DescribeAIWorkbenchSkill, ListAIWorkbenchSkills。

名称 类型 描述
SkillId String

技能 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：skl-****
Name String

技能名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：tcop-prometheus
Description String

技能描述


注意：此字段可能返回 null，表示取不到有效值。
示例值：腾讯云监控数据查询助手
Enabled Boolean

是否启用


注意：此字段可能返回 null，表示取不到有效值。
示例值：true

SlackRobotNoticeTmpl

企业微信机器人内容模板配置

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
ContentTmpl String 是

内容模板


示例值：base64编码模板内容

SlackRobotNoticeTmplMatcher

企业微信机器人通知模板的匹配器

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
MatchingStatus Array of String 是

匹配状态 Invalid;
Trigger 告警触发; Recovery 告警恢复


示例值：["Trigger"]
Template SlackRobotNoticeTmpl 是

模板配置

Tag

标签

被如下接口引用：CreateAIWorkbenchAgent, DescribeAIWorkbenchAgent, ListAIWorkbenchAgents, UpdateAIWorkbenchAgent。

名称 类型 必选 描述
Key String 是 标签key
示例值："abc"
Value String 是 标签value
示例值："abc"

TaskInfo

任务实体

被如下接口引用：ListAIWorkbenchTasks。

名称 类型 描述
TaskId String

任务 ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：tsk-****
Name String

任务名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：基础报告生成测试
Description String

任务描述


注意：此字段可能返回 null，表示取不到有效值。
示例值：每日定时生成一份APM告警分析报告，基于固定模板内容输出结构化报告。
AgentId String

关联 Agent ID


注意：此字段可能返回 null，表示取不到有效值。
示例值：agt-****
PromptTemplate String

提示词模板


注意：此字段可能返回 null，表示取不到有效值。
示例值：任务目标：分析指定时间范围内的告警情况，包括告警概览统计、告警历史分布、关键实例告警详情，并生成包含问题诊断与优化建议的结构化告警分析报告。
OutputFormat String

输出格式: markdown / json


注意：此字段可能返回 null，表示取不到有效值。
示例值：markdown
TriggerType String

触发类型: manual / cron / webhook


注意：此字段可能返回 null，表示取不到有效值。
示例值：external
CronExpr String

Cron 表达式


注意：此字段可能返回 null，表示取不到有效值。
示例值：0 0 * * *
CronTimezone String

Cron 时区


注意：此字段可能返回 null，表示取不到有效值。
示例值：Asia/Shanghai
SkillIds Array of String

关联技能 ID 列表


注意：此字段可能返回 null，表示取不到有效值。
示例值：["skl-****"]
McpEndpointIds Array of String

关联 MCP 端点 ID 列表


注意：此字段可能返回 null，表示取不到有效值。
示例值：["mcp-****"]
TimeoutSec Integer

超时时间(秒)


注意：此字段可能返回 null，表示取不到有效值。
示例值：600
RetryCount Integer

重试次数


注意：此字段可能返回 null，表示取不到有效值。
示例值：0
NotifyIds Array of String

通知id


注意：此字段可能返回 null，表示取不到有效值。
示例值：["notice-****"]
Enabled Boolean

是否启用


注意：此字段可能返回 null，表示取不到有效值。
示例值：true

TeamsRobotNoticeTmpl

企业微信机器人内容模板配置

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
ContentTmpl String 是 内容模板
示例值：告警通知模板{{.PolicyName}}

TeamsRobotNoticeTmplMatcher

企业微信机器人通知模板的匹配器

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
MatchingStatus Array of String 是 匹配状态 Invalid;
Trigger 告警触发; Recovery 告警恢复
示例值：Trigger
Template TeamsRobotNoticeTmpl 是 模板配置

TeamsWorkflowRobotNoticeTmpl

Microsoft Teams 工作流内容模板配置

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
ContentTmpl String 是

内容模板


示例值：5ZGK6K2m6YCa55+l
Version String 是

区分 TeamsWorkflow 是自定义内容还是自定义 POST BODY

枚举值：

  • WorkflowText： 自定义内容
  • WorkflowJson： 自定义 POST BODY

示例值：WorkflowText
TitleTmpl String 否

标题模版


示例值：VGVhbXMgV29ya2Zsb3c=

TeamsWorkflowRobotNoticeTmplMatcher

Microsoft Teams 工作流通知模板的匹配器

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
MatchingStatus Array of String 是

匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复

枚举值：

  • Trigger： 告警触发
  • Recovery： 告警恢复

示例值：["Trigger"]
Template TeamsWorkflowRobotNoticeTmpl 是

模板配置

TriggerDigitalTwinTaskResp

触发数字分身任务响应

被如下接口引用：TriggerAIWorkbenchSREDigitalTwinTask。

名称 类型 必选 描述
TaskID Integer 否 数字分身任务ID
示例值：228

WeWorkRobotNoticeTmpl

企业微信机器人内容模板配置

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
ContentTmpl String 是 内容模板
示例值：告警通知模板{{.PolicyName}}

WeWorkRobotNoticeTmplMatcher

企业微信机器人通知模板的匹配器

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
MatchingStatus Array of String 是 匹配状态 Invalid;
Trigger 告警触发; Recovery 告警恢复
示例值：Trigger
Template WeWorkRobotNoticeTmpl 是 模板配置

WebhookNoticeTmpl

告警通知自定义Webhook内容模板

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
Body String 是 请求体
示例值：e3sibmFtZSI6ICJ7ey5zdGFmZn19In0=
BodyContentType String 否 请求体的类型，非必填、默认为JSON
注意：此字段可能返回 null，表示取不到有效值。
示例值：application/json
Headers Array of WebhookNoticeTmplHeader 否 请求头
注意：此字段可能返回 null，表示取不到有效值。
示例值：[{"Key": "k", "Values": ["v"]}

WebhookNoticeTmplHeader

告警通知自定义Webhook模板中的请求体头部描述

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
Key String 是 http请求中header的key
示例值：key
Values Array of String 是 http请求中header的value
示例值：["v1", "v2"]

WebhookNoticeTmplMatcher

告警通知自定义Webhook的通知内容模板匹配器

被如下接口引用：CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl。

名称 类型 必选 描述
MatchingStatus Array of String 否 匹配状态 Invalid; Trigger 告警触发; Recovery 告警恢复
示例值：Trigger
Template WebhookNoticeTmpl 否 自定义Webhook内容模板
中国站