API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 混沌演练平台 > 数据结构

数据结构

最近更新时间：2024-04-10 01:10:24

我的收藏

本页目录：

ActionFilter

动作库筛选栏位

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

名称 类型 必选 描述
Keyword String 是 关键字
示例值：动作名称
Values Array of String 是 搜索内容值
示例值：["开机","关机"]

ApmServiceInfo

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

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

名称 类型 必选 描述
InstanceId String 是 业务ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：apm-xxxx
ServiceNameList Array of String 是 应用名称
注意：此字段可能返回 null，表示取不到有效值。
示例值： ["innercfg", "zhiyan"]
RegionId Integer 否 地域ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：1

DescribePolicy

查询-保护策略

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskPolicyIdList Array of String 是 保护策略ID列表
示例值：["policy-aaaa","policy-aaaa"]
TaskPolicyStatus String 是 保护策略状态
示例值：已触发
TaskPolicyRule String 是 策略规则
示例值：or
TaskPolicyDealType Integer 是 护栏策略生效处理策略 1:顺序执行，2:暂停
注意：此字段可能返回 null，表示取不到有效值。
示例值：1

PolicyTriggerLog

护栏策略触发日志

被如下接口引用：DescribeTaskPolicyTriggerLog。

名称 类型 描述
TaskId Integer 演练ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：111
Name String 名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：cpu告警
TriggerType Integer 类型，0--触发，1--恢复
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
Content String 内容
注意：此字段可能返回 null，表示取不到有效值。
示例值：内容
CreatTime String 触发时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2022-02-22

TagWithCreate

用于传入创建、编辑标签

被如下接口引用：CreateTaskFromTemplate。

名称 类型 必选 描述
TagKey String 是 标签键
示例值：test
TagValue String 是 标签值
示例值：mytest

TagWithDescribe

展示标签列表

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

名称 类型 必选 描述
TagKey String 是 标签键
示例值：test
TagValue String 是 标签值
示例值：mytest

Task

任务

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskId Integer 是 任务ID
示例值：1
TaskTitle String 是 任务标题
示例值：任务标题
TaskDescription String 是 任务描述
示例值：任务描述
TaskTag String 是 自定义标签
注意：此字段可能返回 null，表示取不到有效值。
示例值：自定义标签
TaskStatus Integer 是 任务状态，1001--未开始 1002--进行中（执行）1003--进行中（暂停）1004--执行结束
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
TaskStatusType Integer 是 任务结束状态，表明任务以何种状态结束: 0 -- 尚未结束，1 -- 成功，2-- 失败，3--终止
示例值：0
TaskProtectStrategy String 是 保护策略
注意：此字段可能返回 null，表示取不到有效值。
示例值：{}
TaskCreateTime String 是 任务创建时间
示例值："2021-08-17 20:05:04"
TaskUpdateTime String 是 任务更新时间
示例值："2021-08-17 20:05:04"
TaskGroups Array of TaskGroup 是 任务动作组
TaskStartTime String 是 开始时间
注意：此字段可能返回 null，表示取不到有效值。
示例值："2021-08-17 20:05:04"
TaskEndTime String 是 结束时间
注意：此字段可能返回 null，表示取不到有效值。
示例值："2021-08-17 20:05:04"
TaskExpect Integer 是 是否符合预期。1：符合预期，2：不符合预期
注意：此字段可能返回 null，表示取不到有效值。
示例值：是否符合预期
TaskSummary String 是 演习记录
注意：此字段可能返回 null，表示取不到有效值。
示例值：演习记录
TaskMode Integer 是 任务模式。1:手工执行，2:自动执行
示例值：1
TaskPauseDuration Integer 是 自动暂停时长。单位分钟
示例值：60
TaskOwnerUin String 是 演练创建者Uin
示例值：6000000000
TaskRegionId Integer 是 地域ID
示例值：1
TaskMonitors Array of TaskMonitor 是 监控指标列表
注意：此字段可能返回 null，表示取不到有效值。
TaskPolicy DescribePolicy 是 保护策略
注意：此字段可能返回 null，表示取不到有效值。
Tags Array of TagWithDescribe 否 标签列表
注意：此字段可能返回 null，表示取不到有效值。
TaskPlanId Integer 否 关联的演练计划ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：2458
TaskPlanTitle String 否 关联的演练计划名称
注意：此字段可能返回 null，表示取不到有效值。
示例值： "运营端计划"
ApplicationId String 否 关联的应用ID
注意：此字段可能返回 null，表示取不到有效值。
示例值："app-faee9ba9"
ApplicationName String 否 关联的应用名称
注意：此字段可能返回 null，表示取不到有效值。
示例值："yh-test001"
AlarmPolicy Array of String 否 关联的告警指标
注意：此字段可能返回 null，表示取不到有效值。
示例值： ["policy-3pklm3so"]
ApmServiceList Array of ApmServiceInfo 否 关联的APM服务
注意：此字段可能返回 null，表示取不到有效值。
VerifyId Integer 否 关联的隐患验证项ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：3001
PolicyDealType Integer 否 护栏处理方式，1--顺序回滚，2--演练暂停
注意：此字段可能返回 null，表示取不到有效值。
示例值：1

TaskConfig

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

被如下接口引用：CreateTaskFromTemplate。

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

TaskGroup

任务分组

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskGroupId Integer 是 任务动作ID
示例值：1
TaskGroupTitle String 是 分组标题
示例值：1
TaskGroupDescription String 是 分组描述
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
TaskGroupOrder Integer 是 任务分组顺序
示例值：1
ObjectTypeId Integer 是 对象类型ID
示例值：1
TaskGroupCreateTime String 是 任务分组创建时间
示例值："2021-08-17 20:05:04"
TaskGroupUpdateTime String 是 任务分组更新时间
示例值："2021-08-17 20:05:04"
TaskGroupActions Array of TaskGroupAction 是 动作分组动作列表
TaskGroupInstanceList Array of String 是 实例列表
示例值：[]
TaskGroupMode Integer 是 执行模式。1 --- 顺序执行，2 --- 阶段执行
示例值：1
TaskGroupDiscardInstanceList Array of String 否 不参演的实例列表
示例值：[]
TaskGroupSelectedInstanceList Array of String 否 参演实例列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：[]
TaskGroupInstancesExecuteRule Array of TaskGroupInstancesExecuteRules 否 机器选取规则
注意：此字段可能返回 null，表示取不到有效值。
示例值：[]

TaskGroupAction

任务分组动作

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskGroupActionId Integer 是 任务分组动作ID
示例值：1
TaskGroupInstances Array of TaskGroupInstance 是 任务分组动作实例列表
ActionId Integer 是 动作ID
示例值：1
TaskGroupActionOrder Integer 是 分组动作顺序
示例值：1
TaskGroupActionGeneralConfiguration String 是 分组动作通用配置
注意：此字段可能返回 null，表示取不到有效值。
示例值：{}
TaskGroupActionCustomConfiguration String 是 分组动作自定义配置
注意：此字段可能返回 null，表示取不到有效值。
示例值：{}
TaskGroupActionStatus Integer 是 分组动作状态
示例值：1
TaskGroupActionCreateTime String 是 动作分组创建时间
示例值："2021-08-17 20:05:04"
TaskGroupActionUpdateTime String 是 动作分组更新时间
示例值："2021-08-17 20:05:04"
ActionTitle String 是 动作名称
示例值：关机
TaskGroupActionStatusType Integer 是 状态类型: 0 -- 无状态，1 -- 成功，2-- 失败，3--终止，4--跳过
示例值：0
TaskGroupActionRandomId Integer 是 RandomId
注意：此字段可能返回 null，表示取不到有效值。
示例值：123456
TaskGroupActionRecoverId Integer 是 RecoverId
注意：此字段可能返回 null，表示取不到有效值。
示例值：123456
TaskGroupActionExecuteId Integer 是 ExecuteId
注意：此字段可能返回 null，表示取不到有效值。
示例值：123456
ActionApiType Integer 否 调用api类型，0:tat, 1:云api
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
ActionAttribute Integer 否 1:故障，2:恢复
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ActionType String 否 动作类型：平台、自定义
注意：此字段可能返回 null，表示取不到有效值。
示例值：平台
IsExecuteRedo Boolean 否 是否可重试
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
ActionRisk String 否 动作风险级别
注意：此字段可能返回 null，表示取不到有效值。
示例值：高风险
TaskGroupActionExecuteTime Integer 否 动作运行时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：10

TaskGroupActionConfig

动作组中的动作参数

被如下接口引用：CreateTaskFromTemplate。

名称 类型 必选 描述
TaskGroupActionOrder Integer 否 该动作在动作组中的顺序，从1开始，不填或填错将匹配不到经验中要修改参数的动作
示例值：1
TaskGroupActionGeneralConfiguration String 否 动作通用参数，需要json序列化传入，可以从查询经验详情接口获取，不填默认使用经验中动作参数
示例值："{"timeout":200,"percentage":80}"
TaskGroupActionCustomConfiguration String 否 动作自定义参数，需要json序列化传入，可以从查询经验详情接口获取，不填默认使用经验中动作参数
示例值："{"PreTimeWait":60,"ActionTimeout":180}"

TaskGroupConfig

动作组的配置项

被如下接口引用：CreateTaskFromTemplate。

名称 类型 必选 描述
TaskGroupInstances Array of String 是 动作组所关联的实例对象
示例值：["ins-y5hy9gnh", "ins-y5hy9g21"]
TaskGroupTitle String 否 动作组标题，不填默认取经验中的动作组名称
示例值：动作组标题
TaskGroupDescription String 否 动作组描述，不填默认取经验中的动作组描述
示例值：动作组描述
TaskGroupMode Integer 否 动作执行模式。1 --- 顺序执行，2 --- 阶段执行, 不填默认取经验中的动作组执行模式
示例值：1
TaskGroupActionsConfig Array of TaskGroupActionConfig 否 动作组中的动作参数，不填默认使用经验中的动作参数，配置时可以只指定想要修改参数的动作
示例值：[]

TaskGroupInstance

任务分组动作实例

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskGroupInstanceId Integer 是 实例ID
示例值：1
TaskGroupInstanceObjectId String 是 实例ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：ins_d1fr3
TaskGroupInstanceStatus Integer 是 实例动作执行状态
示例值：1
TaskGroupInstanceCreateTime String 是 实例创建时间
示例值："2021-08-17 20:05:04"
TaskGroupInstanceUpdateTime String 是 实例更新时间
示例值："2021-08-17 20:05:04"
TaskGroupInstanceStatusType Integer 是 状态类型: 0 -- 无状态，1 -- 成功，2-- 失败，3--终止，4--跳过
示例值：1
TaskGroupInstanceStartTime String 是 执行开始时间
注意：此字段可能返回 null，表示取不到有效值。
示例值："2021-08-17 20:05:04"
TaskGroupInstanceEndTime String 是 执行结束时间
注意：此字段可能返回 null，表示取不到有效值。
示例值："2021-08-17 20:05:04"
TaskGroupInstanceIsRedo Boolean 否 实例是否可重试
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
TaskGroupInstanceExecuteTime Integer 否 动作实例执行时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：10

TaskGroupInstancesExecuteRules

机器选取规则

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskGroupInstancesExecuteMode Integer 否 实例选取模式
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
TaskGroupInstancesExecutePercent Integer 否 按比例选取模式下选取比例
注意：此字段可能返回 null，表示取不到有效值。
示例值：100
TaskGroupInstancesExecuteNum Integer 否 按数量选取模式下选取数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：10

TaskListItem

任务列表信息

被如下接口引用：DescribeTaskList。

名称 类型 描述
TaskId Integer 任务ID
示例值：1
TaskTitle String 任务标题
示例值：“任务标题”
TaskDescription String 任务描述
示例值：“任务描述”
TaskTag String 任务标签
注意：此字段可能返回 null，表示取不到有效值。
示例值：“任务标签”
TaskStatus Integer 任务状态(1001 -- 未开始 1002 -- 进行中 1003 -- 暂停中 1004 -- 任务结束)
示例值：1004
TaskCreateTime String 任务创建时间
示例值："2021-08-17 20:05:04"
TaskUpdateTime String 任务更新时间
示例值："2021-08-17 20:05:04"
TaskPreCheckStatus Integer 0--未开始，1--进行中，2--已完成
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
TaskPreCheckSuccess Boolean 环境检查是否通过
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
TaskExpect Integer 演练是否符合预期 1-符合预期 2-不符合预期
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ApplicationId String 关联应用ID
注意：此字段可能返回 null，表示取不到有效值。
示例值："app-faee9ba9"
ApplicationName String 关联应用名称
注意：此字段可能返回 null，表示取不到有效值。
示例值："yh-test001"
VerifyId Integer 验证项ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：3001
TaskStatusType Integer 状态类型: 0 -- 无状态，1 -- 成功，2-- 失败，3--终止
注意：此字段可能返回 null，表示取不到有效值。
示例值：1

TaskMonitor

监控指标

被如下接口引用：DescribeTask。

名称 类型 必选 描述
TaskMonitorId Integer 是 演练监控指标ID
示例值：1
MetricId Integer 是 监控指标ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
TaskMonitorObjectTypeId Integer 是 监控指标对象类型ID
示例值：1
MetricName String 是 指标名称
示例值：io
InstancesIds Array of String 是 实例ID列表
示例值：["ins1","ins2"]
MetricChineseName String 是 中文指标
注意：此字段可能返回 null，表示取不到有效值。
示例值：中文指标
Unit String 是 单位
注意：此字段可能返回 null，表示取不到有效值。
示例值：%

TaskReportInfo

演练报告状态信息

被如下接口引用：DescribeTask。

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

Template

经验库

被如下接口引用：DescribeTemplate。

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

TemplateGroup

任务分组

被如下接口引用：DescribeTemplate。

名称 类型 必选 描述
TemplateGroupId Integer 是 经验库动作ID
示例值：1
TemplateGroupActions Array of TemplateGroupAction 是 经验库动作分组动作列表
Title String 是 分组标题
示例值：1
Description String 是 分组描述
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
Order Integer 是 分组顺序
示例值：1
Mode Integer 是 执行模式。1 --- 顺序执行，2 --- 阶段执行
示例值：1
ObjectTypeId Integer 是 对象类型ID
示例值：1
CreateTime String 是 分组创建时间
示例值："2021-08-17 20:05:04"
UpdateTime String 是 分组更新时间
示例值："2021-08-17 20:05:04"

TemplateGroupAction

任务分组动作

被如下接口引用：DescribeTemplate。

名称 类型 必选 描述
TemplateGroupActionId Integer 是 经验库分组动作ID
示例值：1
ActionId Integer 是 动作ID
示例值：1
Order Integer 是 分组动作顺序
示例值：1
GeneralConfiguration String 是 分组动作通用配置
注意：此字段可能返回 null，表示取不到有效值。
示例值：{}
CustomConfiguration String 是 分组动作自定义配置
注意：此字段可能返回 null，表示取不到有效值。
示例值：{}
CreateTime String 是 动作分组创建时间
示例值："2021-08-17 20:05:04"
UpdateTime String 是 动作分组更新时间
示例值："2021-08-17 20:05:04"
ActionTitle String 是 动作名称
示例值：关机
RandomId Integer 是 自身随机id
注意：此字段可能返回 null，表示取不到有效值。
示例值：123456
RecoverId Integer 是 恢复动作id
注意：此字段可能返回 null，表示取不到有效值。
示例值：123456
ExecuteId Integer 是 执行动作id
注意：此字段可能返回 null，表示取不到有效值。
示例值：123456
ActionApiType Integer 否 调用api类型，0:tat, 1:云api
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
ActionAttribute Integer 否 1:故障，2:恢复
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ActionType String 否 动作类型：平台和自定义
注意：此字段可能返回 null，表示取不到有效值。
示例值：平台

TemplateListItem

经验库列表信息

被如下接口引用：DescribeTemplateList。

名称 类型 描述
TemplateId Integer 经验库ID
示例值：1
TemplateTitle String 经验库标题
示例值：“标题”
TemplateDescription String 经验库描述
示例值：“描述”
TemplateTag String 经验库标签
注意：此字段可能返回 null，表示取不到有效值。
示例值：“标签”
TemplateIsUsed Integer 经验库状态。1 -- 使用中，2 -- 停用
示例值：1
TemplateCreateTime String 经验库创建时间
示例值："2021-08-17 20:05:04"
TemplateUpdateTime String 经验库更新时间
示例值："2021-08-17 20:05:04"
TemplateUsedNum Integer 经验库关联的任务数量
示例值：1
TemplateSource Integer 经验库来源 0-自建经验 1-专家推荐
注意：此字段可能返回 null，表示取不到有效值。
示例值：0

TemplateMonitor

监控指标

被如下接口引用：DescribeTemplate。

名称 类型 描述
MonitorId Integer pk
示例值：1
MetricId Integer 监控指标ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ObjectTypeId Integer 监控指标对象类型ID
示例值：1
MetricName String 指标名称
示例值：io
MetricChineseName String 中文指标
注意：此字段可能返回 null，表示取不到有效值。
示例值：中文指标

TemplatePolicy

保护策略

被如下接口引用：DescribeTemplate。

名称 类型 描述
TemplatePolicyIdList Array of String 保护策略ID列表
示例值：["policy-aaaa","policy-aaaa"]
TemplatePolicyRule String 策略规则
示例值：or
TemplatePolicyDealType Integer 护栏策略生效处理策略 1:顺序执行，2:暂停
示例值：1
中国站