tencent cloud

APIs

文档APIsTencent Smart Advisor-Chaotic Fault GeneratorData Types

数据结构

Download
聚焦模式
字号
最后更新时间： 2026-07-10 16:49:10

ActionFieldConfigDetail

动作动态参数返回格式

被如下接口引用：DescribeActionFieldConfigList。

名称 类型 描述
Type String 组件类型
可选项如下：
input 文本框
textarea 多行文本框
number 数值输入框
select 选择器
cascader 级联选择器
radio 单选
time 时间选择
Lable String 组件label
Field String 组件唯一标识， 传回后端时的key
DefaultValue String 默认值
Config String 支持配置项如下,可根据需要选择配置项，不需要配置是设置空{}：

{

placeholder: string (占位符)

tooltip: string (提示信息)

reg: RegExp (对输入内容格式进行正则校验的规则)

max: number (对于输入框，限制最大输入字符数，对于数值输入框，设置上限)

min: number (对于数值输入框，设置下限)

step: number (设置数值输入框的步长，默认为1)

format: string (时间选择的格式，如YYYY-MM-DD表示年月日, YYYY-MM-DD HH:mm:ss 表示时分秒)

separator: string[] (多行输入框的分隔符，不传或者为空时表示不分隔，直接返回用户输入的文本字符串)

multiple: boolean (是否多选,对选择器和级联选择器有效)

options: 选择器的选项【支持以下两种形式】

直接给定选项数组 { value: string; label: string }[]
通过调接口获取选项 { api: string(接口地址), params: string[] (接口参数,对应于参数配置的field，前端根据field对应的所有组件的输入值作为参数查询数据， 为空时在组件加载时直接请求数据) }
}
Required Integer 是否必填 (0 -- 否 1-- 是)
Validate String compute配置依赖的其他field满足的条件时通过校验（如：三个表单项中必须至少有一个填写了）

[fieldName,

{ config: 此项保留，等待后面具体场景细化 }

]
Visible String 是否可见

ActionFieldConfigResult

动作栏位配置结果

被如下接口引用：DescribeActionFieldConfigList。

名称 类型 描述
ActionId Integer 动作ID
ActionName String 动作名称
ConfigDetail Array of ActionFieldConfigDetail 动作对应的栏位配置详情

ActionFilter

动作库筛选栏位

被如下接口引用：DescribeActionLibraryList, DescribeTaskList, DescribeTemplateList。

名称 类型 必选 描述
Keyword String 是 关键字
Values Array of String 是 搜索内容值

ActionLibraryListResult

动作库数据列表

被如下接口引用：DescribeActionLibraryList。

名称 类型 描述
ActionName String 动作名称
Desc String 动作描述
ActionType String 动作类型。范围：["平台","自定义"]
CreateTime String 创建时间
Creator String 创建人
UpdateTime String 更新时间
RiskDesc String 动作风险描述
ActionId Integer 动作ID
AttributeId Integer 动作属性（ 1：故障 2：恢复）
RelationActionId Integer 关联的动作ID
ActionCommand String 操作命令
ActionCommandType Integer 动作类型（0 -- tat 1 -- 云API）
ActionContent String 自定义动作的参数，json string
ResourceType String 二级分类
ActionDetail String 动作描述
IsAllowed Boolean 是否允许当前账号使用
ActionBestCase String 最佳实践案例的链接地址
ObjectType String 对象类型
MetricIdList Array of Integer 监控指标ID列表
IsNewAction Boolean 是否是新动作
ObjectTypeId Integer 对象类型ID

ApmServiceInfo

应用性能监控产品中应用信息

被如下接口引用：DescribeTask, DescribeTemplate。

名称 类型 必选 描述
InstanceId String 是 业务ID
ServiceNameList Array of String 是 应用名称
RegionId Integer 否 地域ID

DescribePolicy

查询-保护策略

被如下接口引用：DescribeTask。

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

保护策略ID列表
TaskPolicyStatus String 是

保护策略状态

枚举值：

  • 已触发： 表示已触发护栏策略
  • 未触发： 表示未触发护栏策略
  • 已恢复： 表示护栏策略已恢复
TaskPolicyRule String 是

策略规则
TaskPolicyDealType Integer 是

护栏策略生效处理策略 1:顺序执行，2:暂停

ObjectType

对象类型

被如下接口引用：DescribeObjectTypeList。

名称 类型 描述
ObjectTypeId Integer 对象类型ID
ObjectTypeTitle String 对象类型名称
ObjectTypeLevelOne String 对象类型第一级
ObjectTypeParams ObjectTypeConfig 对象类型参数
ObjectTypeJsonParse ObjectTypeJsonParse tke接口json解析规则，null不需要解析
ObjectHasNewAction Boolean 是否包含新动作
ObjectPlatformName String 对应在平台架构图中的资源类型名称
ObjectSupportType Integer 1：平台支持的对象 2：应用支持的部分对象
ArchLayer Integer 1.接入层 2.逻辑层 3. 数据层
IsArchSvg Boolean 是否支持演练生图

ObjectTypeConfig

对象类型配置

被如下接口引用：DescribeObjectTypeList。

名称 类型 描述
Key String 主键
Fields Array of ObjectTypeConfigFields 对象类型配置字段列表

ObjectTypeConfigFields

对象类型字段类型

被如下接口引用：DescribeObjectTypeList。

名称 类型 必选 描述
Key String 是 instanceId
Header String 是 实例id
Transfer String 否 字段值是否需要转译，当不需要转译时，此字段返回null
JsonParse String 否 tke的pod字段信息解析
Type Integer 否 字段类型 0:str 1:list

ObjectTypeJsonParse

标准pod对象类型下拉数据的解析

被如下接口引用：DescribeObjectTypeList。

名称 类型 描述
NameSpace String 命名空间
WorkloadName String 工作负载名称
LanIP String 节点IP
InstanceId String 节点ID

PolicyTriggerLog

护栏策略触发日志

被如下接口引用：DescribeTaskPolicyTriggerLog。

名称 类型 描述
TaskId Integer 演练ID
Name String 名称
TriggerType Integer 类型，0--触发，1--恢复
Content String 内容
CreatTime String 触发时间

ResourceOffline

资源下线

被如下接口引用：DescribeActionFieldConfigList。

名称 类型 必选 描述
ResourceId Integer 否 资源ID
ResourceDeleteTime String 否 资源下线时间
ResourceDeleteMessage String 否 资源下线提示

TagWithCreate

用于传入创建、编辑标签

被如下接口引用：CreateTaskFromAction, CreateTaskFromTemplate。

名称 类型 必选 描述
TagKey String 是 标签键
TagValue String 是 标签值

TagWithDescribe

展示标签列表

被如下接口引用：DescribeTask, DescribeTaskList, DescribeTemplate, DescribeTemplateList。

名称 类型 必选 描述
TagKey String 是 标签键
TagValue String 是 标签值

Task

任务

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskId Integer 是 任务ID
TaskTitle String 是 任务标题
TaskDescription String 是 任务描述
TaskTag String 是 自定义标签
TaskStatus Integer 是 任务状态，1001--未开始 1002--进行中（执行）1003--进行中（暂停）1004--执行结束
TaskStatusType Integer 是 任务结束状态，表明任务以何种状态结束: 0 -- 尚未结束，1 -- 成功，2-- 失败，3--终止
TaskProtectStrategy String 是 保护策略
注意：此字段可能返回 null，表示取不到有效值。
TaskCreateTime String 是 任务创建时间
TaskUpdateTime String 是 任务更新时间
TaskGroups Array of TaskGroup 是 任务动作组
TaskStartTime String 是 开始时间
注意：此字段可能返回 null，表示取不到有效值。
TaskEndTime String 是 结束时间
注意：此字段可能返回 null，表示取不到有效值。
TaskExpect Integer 是 是否符合预期。1：符合预期，2：不符合预期
注意：此字段可能返回 null，表示取不到有效值。
TaskSummary String 是 演习记录
注意：此字段可能返回 null，表示取不到有效值。
TaskMode Integer 是 任务模式。1:手工执行，2:自动执行
TaskPauseDuration Integer 是 自动暂停时长。单位分钟
TaskOwnerUin String 是 演练创建者Uin
TaskRegionId Integer 是 地域ID
TaskMonitors Array of TaskMonitor 是 监控指标列表
TaskPolicy DescribePolicy 是 保护策略
注意：此字段可能返回 null，表示取不到有效值。
Tags Array of TagWithDescribe 否 标签列表
TaskPlanId Integer 否 关联的演练计划ID
注意：此字段可能返回 null，表示取不到有效值。
TaskPlanTitle String 否 关联的演练计划名称
注意：此字段可能返回 null，表示取不到有效值。
ApplicationId String 否 关联的应用ID
注意：此字段可能返回 null，表示取不到有效值。
ApplicationName String 否 关联的应用名称
AlarmPolicy Array of String 否 关联的告警指标
ApmServiceList Array of ApmServiceInfo 否 关联的APM服务
VerifyId Integer 否 关联的隐患验证项ID
注意：此字段可能返回 null，表示取不到有效值。
PolicyDealType Integer 否 护栏处理方式，1--顺序回滚，2--演练暂停
TaskPlanStartTime String 否 计划开始时间
注意：此字段可能返回 null，表示取不到有效值。
TaskPlanEndTime String 否 计划结束时间
注意：此字段可能返回 null，表示取不到有效值。
TaskOrg Array of TaskOrg 否 人员组织
注意：此字段可能返回 null，表示取不到有效值。
TaskIssue String 否 问题和改进
注意：此字段可能返回 null，表示取不到有效值。
TaskRegionName String 否 region信息
TaskArchId String 否 架构ID
TaskScenario Array of TaskTarget 否 演练场景
TaskPurpose Array of TaskTarget 否 演练目的

TaskConfig

从经验模板创建演练时需要配置的任务参数

被如下接口引用：CreateTaskFromTemplate。

名称 类型 必选 描述
TaskGroupsConfig Array of TaskGroupConfig 是 动作组配置，需要保证配置个数和经验中的动作组个数一致
TaskTitle String 否 更改后的演练名称，不填则默认取经验名称
TaskDescription String 否 更改后的演练描述，不填则默认取经验描述
TaskMode Integer 否 演练执行模式：1----手工执行/ 2 ---自动执行，不填则默认取经验执行模式
TaskPauseDuration Integer 否 演练自动暂停时间，单位分钟, 不填则默认取经验自动暂停时间
Tags Array of TagWithCreate 否 演练标签信息，不填则默认取经验标签
PolicyDealType Integer 否 护栏处理方式，1--顺序回滚，2--演练暂停

TaskGroup

任务分组

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskGroupId Integer 是 任务动作ID
TaskGroupTitle String 是 分组标题
TaskGroupDescription String 是 分组描述
TaskGroupOrder Integer 是 任务分组顺序
ObjectTypeId Integer 是 对象类型ID
TaskGroupCreateTime String 是 任务分组创建时间
TaskGroupUpdateTime String 是 任务分组更新时间
TaskGroupActions Array of TaskGroupAction 是 动作分组动作列表
TaskGroupInstanceList Array of String 是 实例列表
TaskGroupMode Integer 是 执行模式。1 --- 顺序执行，2 --- 阶段执行
TaskGroupDiscardInstanceList Array of String 否 不参演的实例列表
TaskGroupSelectedInstanceList Array of String 否 参演实例列表
TaskGroupInstancesExecuteRule Array of TaskGroupInstancesExecuteRules 否 机器选取规则

TaskGroupAction

任务分组动作

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskGroupActionId Integer 是

任务分组动作ID
TaskGroupInstances Array of TaskGroupInstance 是

任务分组动作实例列表
ActionId Integer 是

动作ID
TaskGroupActionOrder Integer 是

分组动作顺序
TaskGroupActionGeneralConfiguration String 是

分组动作通用配置
TaskGroupActionCustomConfiguration String 是

分组动作自定义配置
TaskGroupActionStatus Integer 是

分组动作状态

枚举值：

  • 2001： 未开始
  • 2002： 待执行
  • 2003： 执行中
  • 2004： 执行结束
TaskGroupActionCreateTime String 是

动作分组创建时间
TaskGroupActionUpdateTime String 是

动作分组更新时间
ActionTitle String 是

动作名称
TaskGroupActionStatusType Integer 是

状态类型: 0 -- 无状态，1 -- 成功，2-- 失败，3--终止，4--跳过
TaskGroupActionRandomId Integer 是

RandomId
TaskGroupActionRecoverId Integer 是

RecoverId
TaskGroupActionExecuteId Integer 是

ExecuteId
ActionApiType Integer 否

调用api类型，0:tat, 1:云api
ActionAttribute Integer 否

1:故障，2:恢复
ActionType String 否

动作类型：平台、自定义
IsExecuteRedo Boolean 否

是否可重试
ActionRisk String 否

动作风险级别
TaskGroupActionExecuteTime Integer 否

动作运行时间

单位：秒
TaskGroupActionStartTime String 否

动作开始执行时间

TaskGroupActionConfig

动作组中的动作参数

被如下接口引用：CreateTaskFromTemplate。

名称 类型 必选 描述
TaskGroupActionOrder Integer 否 该动作在动作组中的顺序，从1开始，不填或填错将匹配不到经验中要修改参数的动作
TaskGroupActionGeneralConfiguration String 否 动作通用参数，需要json序列化传入，可以从查询经验详情接口获取，不填默认使用经验中动作参数
TaskGroupActionCustomConfiguration String 否 动作自定义参数，需要json序列化传入，可以从查询经验详情接口获取，不填默认使用经验中动作参数

TaskGroupConfig

动作组的配置项

被如下接口引用：CreateTaskFromTemplate。

名称 类型 必选 描述
TaskGroupInstances Array of String 是 动作组所关联的实例对象
CVM ins-xxx
MySQL cdb-xxx
CLB lb-xxx
Redis crs-xxx
NAT网关 nat-xxx
专线-独享专用通道 dcx-xxx
标准集群普通节点 {"ClusterId":"cls-xxx","InstanceId":"ins-xxx","LanIP":"1.1.1.1"}
标准集群Pod {"ClusterId":"cls-xxx","PodName":"podname","NodeName":"1.1.1.1","NameSpace":"ns","Workload":"workload"}
TDSQL-MySQL(InnoDB) tdsqlshard-xxx
TDSQL-C cynosdbmysql-xxx
VPC子网 subnet-xxxx
CKafka ckafka-xxx
MariaDB tdsql-xxxx
PostgreSQL postgres-xxx
云原生网关 gateway-xxx
标准集群超级节点 {"ClusterId":"cls-xxx","InstanceId":"eklet-xxx","LanIP":"1.1.1.1,"NodePoolId":"np-xxx"}
Serverless集群超级节点 {"ClusterId":"cls-xxxx","InstanceId":"eklet-xxxx","LanIP":"1.1.1.1"}
Elasticsearch集群 es-xxxx
RabbitMQ amqp-xxxx
TaskGroupTitle String 否 动作组标题，不填默认取经验中的动作组名称
TaskGroupDescription String 否 动作组描述，不填默认取经验中的动作组描述
TaskGroupMode Integer 否 动作执行模式。1 --- 顺序执行，2 --- 阶段执行, 不填默认取经验中的动作组执行模式
TaskGroupActionsConfig Array of TaskGroupActionConfig 否 动作组中的动作参数，不填默认使用经验中的动作参数，配置时可以只指定想要修改参数的动作

TaskGroupInstance

任务分组动作实例

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskGroupInstanceId Integer 是

实例ID
TaskGroupInstanceObjectId String 是

实例ID
TaskGroupInstanceStatus Integer 是

实例动作执行状态

枚举值：

  • 3001： 未开始
  • 3002： 执行中
  • 3003： 执行结束
  • 3004： 准备中
TaskGroupInstanceCreateTime String 是

实例创建时间
TaskGroupInstanceUpdateTime String 是

实例更新时间
TaskGroupInstanceStatusType Integer 是

状态类型: 0 -- 无状态，1 -- 成功，2-- 失败，3--终止，4--跳过
TaskGroupInstanceStartTime String 是

执行开始时间
TaskGroupInstanceEndTime String 是

执行结束时间
TaskGroupInstanceIsRedo Boolean 否

实例是否可重试
TaskGroupInstanceExecuteTime Integer 否

动作实例执行时间

单位：秒

TaskGroupInstancesExecuteRules

机器选取规则

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskGroupInstancesExecuteMode Integer 否

实例选取模式

枚举值：

  • 1： 全部注入
  • 2： 随机选取指定比例注入
  • 3： 随机选取指定数量注入
TaskGroupInstancesExecutePercent Integer 否

按比例选取模式下选取比例
TaskGroupInstancesExecuteNum Integer 否

按数量选取模式下选取数量

TaskListItem

任务列表信息

被如下接口引用：DescribeTaskList。

名称 类型 描述
TaskId Integer

任务ID
TaskTitle String

任务标题
TaskDescription String

任务描述
TaskTag String

任务标签
TaskStatus Integer

任务状态(1001 -- 未开始 1002 -- 进行中 1003 -- 暂停中 1004 -- 任务结束)
TaskCreateTime String

任务创建时间
TaskUpdateTime String

任务更新时间
TaskPreCheckStatus Integer

0--未开始，1--进行中，2--已完成
TaskPreCheckSuccess Boolean

环境检查是否通过
TaskExpect Integer

演练是否符合预期 1-符合预期 2-不符合预期
ApplicationId String

关联应用ID
ApplicationName String

关联应用名称
VerifyId Integer

验证项ID
TaskStatusType Integer

状态类型: 0 -- 无状态，1 -- 成功，2-- 失败，3--终止
ArchId String

架构ID
ArchName String

架构名称
TaskSource Integer

来源
Tags Array of TagWithDescribe

云资源标签列表

TaskMonitor

监控指标

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskMonitorId Integer 是 演练监控指标ID
MetricId Integer 是 监控指标ID
TaskMonitorObjectTypeId Integer 是 监控指标对象类型ID
MetricName String 是 指标名称
InstancesIds Array of String 是 实例ID列表
MetricChineseName String 是 中文指标
Unit String 是 单位

TaskOrg

演练人员组织

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskRole String 否 演练角色
TaskOperator String 否 负责人

TaskReportInfo

演练报告状态信息

被如下接口引用：DescribeTask。

名称 类型 描述
Stage Integer 0--未开始，1--正在导出，2--导出成功，3--导出失败
CreateTime String 创建时间
ExpirationTime String 有效期截止时间
Expired Boolean 是否有效
CosUrl String 演练报告cos文件地址
Log String 演练报告导出日志
注意：此字段可能返回 null，表示取不到有效值。
ArchiveStage Integer 0--未开始，1--正在归档，2--归档成功，3--归档失败
ArchiveTime String 归档时间
ArchiveUuid String 归档ID

TaskTarget

演练目标

被如下接口引用：DescribeTask, DescribeTemplate。

名称 类型 必选 描述
TargetId Integer 否

目标标签ID
TargetDesc String 否

目标描述
Type Integer 否

1:演练场景
2:演练目标
Source Integer 否

1:平台 2:用户个人
TargetStatus Integer 否

目标标签是否已被删除

枚举值：

  • 0： 未删除
  • 1： 已删除

Template

经验库

被如下接口引用：DescribeTemplate。

名称 类型 描述
TemplateId Integer 经验库ID
TemplateTitle String 经验库标题
TemplateDescription String 经验库描述
TemplateTag String 自定义标签
TemplateIsUsed Integer 使用状态。1 ---- 使用中，2 --- 停用
TemplateCreateTime String 经验库创建时间
TemplateUpdateTime String 经验库更新时间
TemplateMode Integer 经验库模式。1:手工执行，2:自动执行
TemplatePauseDuration Integer 自动暂停时长。单位分钟
TemplateOwnerUin String 演练创建者Uin
TemplateRegionId Integer 地域ID
TemplateGroups Array of TemplateGroup 动作组
TemplateMonitors Array of TemplateMonitor 监控指标
TemplatePolicy TemplatePolicy 护栏监控
注意：此字段可能返回 null，表示取不到有效值。
Tags Array of TagWithDescribe 标签列表
TemplateSource Integer 经验来源 0-自建 1-专家推荐
ApmServiceList Array of ApmServiceInfo apm应用信息
AlarmPolicy Array of String 告警指标
PolicyDealType Integer 护栏处理方式，1--顺序回滚，2--演练暂停
TemplateScenario Array of TaskTarget 演练场景
TemplatePurpose Array of TaskTarget 演练目的

TemplateGroup

任务分组

被如下接口引用：DescribeTemplate。

名称 类型 必选 描述
TemplateGroupId Integer 是 经验库动作ID
TemplateGroupActions Array of TemplateGroupAction 是 经验库动作分组动作列表
Title String 是 分组标题
Description String 是 分组描述
Order Integer 是 分组顺序
Mode Integer 是 执行模式。1 --- 顺序执行，2 --- 阶段执行
ObjectTypeId Integer 是 对象类型ID
CreateTime String 是 分组创建时间
UpdateTime String 是 分组更新时间

TemplateGroupAction

任务分组动作

被如下接口引用：DescribeTemplate。

名称 类型 必选 描述
TemplateGroupActionId Integer 是 经验库分组动作ID
ActionId Integer 是 动作ID
Order Integer 是 分组动作顺序
GeneralConfiguration String 是 分组动作通用配置
CustomConfiguration String 是 分组动作自定义配置
CreateTime String 是 动作分组创建时间
UpdateTime String 是 动作分组更新时间
ActionTitle String 是 动作名称
RandomId Integer 是 自身随机id
RecoverId Integer 是 恢复动作id
ExecuteId Integer 是 执行动作id
ActionApiType Integer 否 调用api类型，0:tat, 1:云api
ActionAttribute Integer 否 1:故障，2:恢复
ActionType String 否 动作类型：平台和自定义
ActionRisk String 否 动作风险等级，1:低风险 2:中风险 3:高风险
FailurePerformance String 否 故障表现

TemplateListItem

经验库列表信息

被如下接口引用：DescribeTemplateList。

名称 类型 描述
TemplateId Integer 经验库ID
TemplateTitle String 经验库标题
TemplateDescription String 经验库描述
TemplateTag String 经验库标签
TemplateIsUsed Integer 经验库状态。1 -- 使用中，2 -- 停用
TemplateCreateTime String 经验库创建时间
TemplateUpdateTime String 经验库更新时间
TemplateUsedNum Integer 经验库关联的任务数量
TemplateSource Integer 经验库来源 0-自建经验 1-专家推荐

TemplateMonitor

监控指标

被如下接口引用：DescribeTemplate。

名称 类型 描述
MonitorId Integer pk
MetricId Integer 监控指标ID
ObjectTypeId Integer 监控指标对象类型ID
MetricName String 指标名称
MetricChineseName String 中文指标

TemplatePolicy

保护策略

被如下接口引用：DescribeTemplate。

名称 类型 描述
TemplatePolicyIdList Array of String 保护策略ID列表
TemplatePolicyRule String 策略规则
TemplatePolicyDealType Integer 护栏策略生效处理策略 1:顺序执行，2:暂停
上一篇: DescribeTemplateList下一篇: Error Codes

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈