{
  "name": "cfg",
  "display_name": "智能顾问-混沌演练",
  "description": "介绍如何使用API对混沌工程平台进行操作，包括创建演练、创建演练分组、创建经验库等",
  "domain": "other",
  "api_version": "2021-08-20",
  "endpoint": "cfg.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateTaskFromAction",
      "description": "从动作创建演练",
      "status": "online",
      "parameters": [
        {
          "name": "TaskActionId",
          "type": "integer",
          "required": true,
          "description": "动作ID，可从动作列表接口DescribeActionLibraryList获取",
          "example": "127"
        },
        {
          "name": "TaskInstances",
          "type": "array",
          "required": true,
          "description": "参与演练的实例ID",
          "example": "[\"ins-87b12frpq\"]",
          "item_type": "string"
        },
        {
          "name": "TaskTitle",
          "type": "string",
          "required": false,
          "description": "演练名称，不填则默认取动作名称",
          "example": "演练名称"
        },
        {
          "name": "TaskDescription",
          "type": "string",
          "required": false,
          "description": "演练描述，不填则默认取动作描述",
          "example": "演练描述"
        },
        {
          "name": "TaskActionGeneralConfiguration",
          "type": "string",
          "required": false,
          "description": "动作通用参数，需要json序列化传入，可以从动作详情接口DescribeActionFieldConfigList获取，不填默认使用动作默认参数",
          "example": "\"{\\\"ActionTimeout\\\":1800,\\\"AfterTimeWait\\\":0,\\\"PreTimeWait\\\":0,\\\"AliasTitle\\\":\\\"\\\"}\""
        },
        {
          "name": "TaskActionCustomConfiguration",
          "type": "string",
          "required": false,
          "description": "动作自定义参数，需要json序列化传入，可以从动作详情接口DescribeActionFieldConfigList获取，不填默认使用动作默认参数，注意：必填参数，是没有默认值的 ，务必保证传入有效值",
          "example": "\"{\\\"timeout\\\":200,\\\"percentage\\\":80}\""
        },
        {
          "name": "TaskPauseDuration",
          "type": "integer",
          "required": false,
          "description": "演练自动暂停时间，单位分钟, 不填则默认为60",
          "example": "60"
        },
        {
          "name": "TaskTags",
          "type": "array",
          "required": false,
          "description": "标签列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "资源归属"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签值",
              "example": "前端一组"
            }
          ]
        }
      ],
      "required": [
        "TaskActionId",
        "TaskInstances"
      ]
    },
    {
      "name": "CreateTaskFromMultiAction",
      "description": "以多个动作创建演练",
      "status": "online",
      "parameters": [
        {
          "name": "TaskInstances",
          "type": "array",
          "required": true,
          "description": "参与演练的实例ID CVM ins-xxx MySQL cdb-xxx CLB lb-xxx Redis crs-xxx NAT网关 nat-xxx Redis crs-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 云原...",
          "example": "[\"ins-87b12frpq\"]",
          "item_type": "string"
        },
        {
          "name": "TaskTitle",
          "type": "string",
          "required": false,
          "description": "演练名称，不填则默认取动作名称",
          "example": "演练名称"
        },
        {
          "name": "TaskDescription",
          "type": "string",
          "required": false,
          "description": "演练描述，不填则默认取动作描述",
          "example": "演练描述"
        },
        {
          "name": "TaskPauseDuration",
          "type": "integer",
          "required": false,
          "description": "演练自动暂停时间，单位分钟, 不填则默认为60",
          "example": "60"
        },
        {
          "name": "TaskAction",
          "type": "array",
          "required": false,
          "description": "演练动作组配置",
          "example": "[{     \"TaskActionId\": 0,     \"TaskActionGeneralConfiguration\": \"abc\",     \"TaskActionCustomConfiguration\": \"abc\"   }]",
          "item_type": "object",
          "children": [
            {
              "name": "TaskActionId",
              "type": "integer",
              "required": false,
              "description": "动作ID",
              "example": "1"
            },
            {
              "name": "TaskActionGeneralConfiguration",
              "type": "string",
              "required": false,
              "description": "{\"ActionTimeout\":1800}",
              "example": "动作通用参数"
            },
            {
              "name": "TaskActionCustomConfiguration",
              "type": "string",
              "required": false,
              "description": "{\"ip\": \"0.0.0.0\"}",
              "example": "动作特有参数"
            }
          ]
        }
      ],
      "required": [
        "TaskInstances"
      ]
    },
    {
      "name": "CreateTaskFromTemplate",
      "description": "从经验库创建演练",
      "status": "online",
      "parameters": [
        {
          "name": "TemplateId",
          "type": "integer",
          "required": true,
          "description": "从经验库中查询到的经验模板ID",
          "example": "11"
        },
        {
          "name": "TaskConfig",
          "type": "object",
          "required": true,
          "description": "演练的配置参数",
          "example": "无",
          "children": [
            {
              "name": "TaskGroupsConfig",
              "type": "array",
              "required": true,
              "description": "动作组配置，需要保证配置个数和经验中的动作组个数一致",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "TaskGroupInstances",
                  "type": "array",
                  "required": true,
                  "description": "动作组所关联的实例对象 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 云原生\ufffd...",
                  "example": "[\"ins-y5hy9gnh\", \"ins-y5hy9g21\"]",
                  "item_type": "string"
                },
                {
                  "name": "TaskGroupTitle",
                  "type": "string",
                  "required": false,
                  "description": "动作组标题，不填默认取经验中的动作组名称",
                  "example": "动作组标题"
                },
                {
                  "name": "TaskGroupDescription",
                  "type": "string",
                  "required": false,
                  "description": "动作组描述，不填默认取经验中的动作组描述",
                  "example": "动作组描述"
                },
                {
                  "name": "TaskGroupMode",
                  "type": "integer",
                  "required": false,
                  "description": "动作执行模式。1 --- 顺序执行，2 --- 阶段执行, 不填默认取经验中的动作组执行模式",
                  "example": "1"
                },
                {
                  "name": "TaskGroupActionsConfig",
                  "type": "array",
                  "required": false,
                  "description": "动作组中的动作参数，不填默认使用经验中的动作参数，配置时可以只指定想要修改参数的动作",
                  "example": "[{\"duration\":0}]",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "TaskGroupActionOrder",
                      "type": "integer",
                      "required": false,
                      "description": "该动作在动作组中的顺序，从1开始，不填或填错将匹配不到经验中要修改参数的动作",
                      "example": "1"
                    },
                    {
                      "name": "TaskGroupActionGeneralConfiguration",
                      "type": "string",
                      "required": false,
                      "description": "动作通用参数，需要json序列化传入，可以从查询经验详情接口获取，不填默认使用经验中动作参数",
                      "example": "\"{\\\"timeout\\\":200,\\\"percentage\\\":80}\""
                    },
                    {
                      "name": "TaskGroupActionCustomConfiguration",
                      "type": "string",
                      "required": false,
                      "description": "动作自定义参数，需要json序列化传入，可以从查询经验详情接口获取，不填默认使用经验中动作参数",
                      "example": "\"{\\\"PreTimeWait\\\":60,\\\"ActionTimeout\\\":180}\""
                    }
                  ]
                }
              ]
            },
            {
              "name": "TaskTitle",
              "type": "string",
              "required": false,
              "description": "更改后的演练名称，不填则默认取经验名称",
              "example": "演练名称"
            },
            {
              "name": "TaskDescription",
              "type": "string",
              "required": false,
              "description": "更改后的演练描述，不填则默认取经验描述",
              "example": "演练描述"
            },
            {
              "name": "TaskMode",
              "type": "integer",
              "required": false,
              "description": "演练执行模式：1----手工执行/ 2 ---自动执行，不填则默认取经验执行模式",
              "example": "1"
            },
            {
              "name": "TaskPauseDuration",
              "type": "integer",
              "required": false,
              "description": "演练自动暂停时间，单位分钟, 不填则默认取经验自动暂停时间",
              "example": "60"
            },
            {
              "name": "Tags",
              "type": "array",
              "required": false,
              "description": "演练标签信息，不填则默认取经验标签",
              "example": "[]",
              "item_type": "object",
              "children": [
                {
                  "name": "TagKey",
                  "type": "string",
                  "required": true,
                  "description": "标签键",
                  "example": "资源归属"
                },
                {
                  "name": "TagValue",
                  "type": "string",
                  "required": true,
                  "description": "标签值",
                  "example": "前端一组"
                }
              ]
            },
            {
              "name": "PolicyDealType",
              "type": "integer",
              "required": false,
              "description": "护栏处理方式，1--顺序回滚，2--演练暂停",
              "example": "1"
            }
          ]
        }
      ],
      "required": [
        "TemplateId",
        "TaskConfig"
      ]
    },
    {
      "name": "DeleteTask",
      "description": "删除任务",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "任务ID",
          "example": "5689"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "DescribeActionFieldConfigList",
      "description": "根据动作ID获取动作栏位动态配置参数信息，里面包含动作自有和通用两部分参数。",
      "status": "online",
      "parameters": [
        {
          "name": "ActionIds",
          "type": "array",
          "required": true,
          "description": "动作ID列表",
          "example": "[1,2,3]",
          "item_type": "integer"
        },
        {
          "name": "ObjectTypeId",
          "type": "integer",
          "required": true,
          "description": "对象类型ID",
          "example": "10"
        }
      ],
      "required": [
        "ActionIds",
        "ObjectTypeId"
      ]
    },
    {
      "name": "DescribeActionLibraryList",
      "description": "获取混沌演练平台的动作库列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "0-100",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "默认值0",
          "example": "0"
        },
        {
          "name": "ObjectType",
          "type": "integer",
          "required": true,
          "description": "对象类型ID",
          "example": "1"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "Keyword取值{\"动作名称\": \"a_title\", \"描述\": \"a_desc\", \"动作类型\": \"a_type\", \"创建时间\": \"a_create_time\", \"二级分类\": \"a_resource_type\"}",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": true,
              "description": "关键字",
              "example": "动作名称"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "搜索内容值",
              "example": "[\"开机\",\"关机\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Attribute",
          "type": "array",
          "required": false,
          "description": "动作分类，1表示故障动作，2表示恢复动作",
          "example": "[1,2]",
          "item_type": "integer"
        },
        {
          "name": "ActionIds",
          "type": "array",
          "required": false,
          "description": "筛选项 -动作ID",
          "example": "1",
          "item_type": "integer"
        }
      ],
      "required": [
        "Limit",
        "Offset",
        "ObjectType"
      ]
    },
    {
      "name": "DescribeObjectTypeList",
      "description": "查询对象类型列表",
      "status": "online",
      "parameters": [
        {
          "name": "SupportType",
          "type": "integer",
          "required": false,
          "description": "所支持的对象 0：全平台产品 1：平台接入的对象 2：应用所支持的部分对象",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeTask",
      "description": "查询任务",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "任务ID",
          "example": "1"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "DescribeTaskExecuteLogs",
      "description": "获取演练过程中的所有日志",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "任务ID",
          "example": "10"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "返回的内容行数",
          "example": "100"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "日志起始的行数。",
          "example": "10"
        }
      ],
      "required": [
        "TaskId",
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "DescribeTaskList",
      "description": "查询任务列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "分页Limit",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "分页Offset",
          "example": "0"
        },
        {
          "name": "TaskTitle",
          "type": "string",
          "required": false,
          "description": "演练名称",
          "example": "\"1\""
        },
        {
          "name": "TaskTag",
          "type": "array",
          "required": false,
          "description": "标签键",
          "example": "[\"1\"]",
          "item_type": "string"
        },
        {
          "name": "TaskStatus",
          "type": "integer",
          "required": false,
          "description": "任务状态(1001 -- 未开始 1002 -- 进行中 1003 -- 暂停中 1004 -- 任务结束)",
          "example": "1"
        },
        {
          "name": "TaskStartTime",
          "type": "string",
          "required": false,
          "description": "开始时间，固定格式%Y-%m-%d %H:%M:%S",
          "example": "\"1\""
        },
        {
          "name": "TaskEndTime",
          "type": "string",
          "required": false,
          "description": "结束时间，固定格式%Y-%m-%d %H:%M:%S",
          "example": "\"1\""
        },
        {
          "name": "TaskUpdateTime",
          "type": "string",
          "required": false,
          "description": "更新时间，固定格式%Y-%m-%d %H:%M:%S",
          "example": "\"2024-03-09 20:59:59\""
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "标签对",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "资源归属"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签值",
              "example": "研发组"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "筛选条件",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": true,
              "description": "关键字",
              "example": "动作名称"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "搜索内容值",
              "example": "[\"开机\",\"关机\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "TaskId",
          "type": "array",
          "required": false,
          "description": "演练ID",
          "example": "[5871]",
          "item_type": "integer"
        },
        {
          "name": "ApplicationId",
          "type": "array",
          "required": false,
          "description": "关联应用ID筛选",
          "example": "[\"app-faee9ba9\"]",
          "item_type": "string"
        },
        {
          "name": "ApplicationName",
          "type": "array",
          "required": false,
          "description": "关联应用筛选",
          "example": "[\"yh-test001\"]",
          "item_type": "string"
        },
        {
          "name": "TaskStatusList",
          "type": "array",
          "required": false,
          "description": "任务状态筛选--支持多选 任务状态(1001 -- 未开始 1002 -- 进行中 1003 -- 暂停中 1004 -- 任务结束)",
          "example": "[1001, 1002]",
          "item_type": "integer"
        },
        {
          "name": "ArchId",
          "type": "string",
          "required": false,
          "description": "架构ID",
          "example": "arch-xxxx"
        },
        {
          "name": "ArchName",
          "type": "string",
          "required": false,
          "description": "架构名称",
          "example": "游戏战斗服架构图"
        }
      ],
      "required": [
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "DescribeTaskPolicyTriggerLog",
      "description": "获取护栏触发日志",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "演练ID",
          "example": "1066"
        },
        {
          "name": "Page",
          "type": "integer",
          "required": true,
          "description": "页码",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "页数量",
          "example": "24"
        }
      ],
      "required": [
        "TaskId",
        "Page",
        "PageSize"
      ]
    },
    {
      "name": "DescribeTemplate",
      "description": "查询经验库",
      "status": "online",
      "parameters": [
        {
          "name": "TemplateId",
          "type": "integer",
          "required": true,
          "description": "经验库ID",
          "example": "1"
        }
      ],
      "required": [
        "TemplateId"
      ]
    },
    {
      "name": "DescribeTemplateList",
      "description": "查询经验库列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "分页Limit, 最大值100",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "分页Offset",
          "example": "0"
        },
        {
          "name": "Title",
          "type": "string",
          "required": false,
          "description": "演练名称",
          "example": "\"1\""
        },
        {
          "name": "Tag",
          "type": "array",
          "required": false,
          "description": "标签键",
          "example": "\"1\"",
          "item_type": "string"
        },
        {
          "name": "IsUsed",
          "type": "integer",
          "required": false,
          "description": "状态，1---使用中， 2---停用",
          "example": "1"
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "标签对",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "资源归属"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签值",
              "example": "研发组"
            }
          ]
        },
        {
          "name": "TemplateSource",
          "type": "integer",
          "required": false,
          "description": "经验来源 0-自建 1-专家推荐",
          "example": "0"
        },
        {
          "name": "TemplateIdList",
          "type": "array",
          "required": false,
          "description": "经验ID",
          "example": "1870",
          "item_type": "integer"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤参数",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Keyword",
              "type": "string",
              "required": true,
              "description": "关键字",
              "example": "动作名称"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "搜索内容值",
              "example": "[\"开机\",\"关机\"]",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": [
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "ExecuteTask",
      "description": "执行任务",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "需要执行的任务ID",
          "example": "1"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "ExecuteTaskInstance",
      "description": "触发混沌演练任务的动作，对于实例进行演练操作",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "任务ID",
          "example": "10"
        },
        {
          "name": "TaskActionId",
          "type": "integer",
          "required": true,
          "description": "任务动作ID",
          "example": "20"
        },
        {
          "name": "TaskInstanceIds",
          "type": "array",
          "required": true,
          "description": "任务动作实例ID",
          "example": "[1,2,3]",
          "item_type": "integer"
        },
        {
          "name": "IsOperateAll",
          "type": "boolean",
          "required": true,
          "description": "是否操作整个任务",
          "example": "true"
        },
        {
          "name": "ActionType",
          "type": "integer",
          "required": true,
          "description": "操作类型：（1--启动 2--执行 3--跳过 5--重试）",
          "example": "1"
        },
        {
          "name": "TaskGroupId",
          "type": "integer",
          "required": true,
          "description": "动作组ID",
          "example": "1"
        }
      ],
      "required": [
        "TaskId",
        "TaskActionId",
        "TaskInstanceIds",
        "IsOperateAll",
        "ActionType",
        "TaskGroupId"
      ]
    },
    {
      "name": "ModifyTaskRunStatus",
      "description": "修改任务运行状态",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "任务ID",
          "example": "5432"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "任务状态, 1001--未开始 1002--进行中（执行）1003--进行中（暂停）1004--执行结束",
          "example": "1002"
        },
        {
          "name": "IsExpect",
          "type": "boolean",
          "required": false,
          "description": "执行结果是否符合预期（当前扭转状态为执行结束时，需要必传此字段）",
          "example": "true"
        },
        {
          "name": "Summary",
          "type": "string",
          "required": false,
          "description": "演习结论（当演习状态转变为执行结束时，需要填写此字段）",
          "example": "演练总结"
        },
        {
          "name": "Issue",
          "type": "string",
          "required": false,
          "description": "问题以及改进",
          "example": "演练问题"
        },
        {
          "name": "Record",
          "type": "string",
          "required": false,
          "description": "演练记录",
          "example": "演练记录"
        }
      ],
      "required": [
        "TaskId",
        "Status"
      ]
    },
    {
      "name": "TriggerPolicy",
      "description": "用于触发混沌演练护栏（类型为触发和恢复2种）",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "混沌演练ID",
          "example": "5871"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "名称",
          "example": "cpu告警"
        },
        {
          "name": "Content",
          "type": "string",
          "required": true,
          "description": "触发内容",
          "example": "触发CPU利用率\u003e80%"
        },
        {
          "name": "TriggerType",
          "type": "integer",
          "required": true,
          "description": "触发类型，0--触发；1--恢复",
          "example": "0"
        }
      ],
      "required": [
        "TaskId",
        "Name",
        "Content",
        "TriggerType"
      ]
    }
  ]
}