{
  "name": "tat",
  "display_name": "自动化助手",
  "description": "介绍腾讯云自动化助手的API，例如使用API创建命令，触发命令，查询指令执行结果等。",
  "domain": "monitor",
  "api_version": "2020-10-28",
  "endpoint": "tat.tencentcloudapi.com",
  "actions": [
    {
      "name": "CancelInvocation",
      "description": "取消一台或多台实例执行的命令 * 如果命令还未下发到agent，任务状态处于PENDING、DELIVERING、DELIVER_DELAYED，取消后任务状态是CANCELLED * 如果命令已下发到agent，任务状态处于RUNNING， 取消后任务状态是TERMINATED",
      "status": "online",
      "parameters": [
        {
          "name": "InvocationId",
          "type": "string",
          "required": true,
          "description": "执行活动ID。 可通过 [DescribeInvocations(查询执行活动)](https://cloud.tencent.com/document/api/1340/52679) 接口获取。",
          "example": "inv-xxxxxxxx"
        },
        {
          "name": "InstanceIds",
          "type": "array",
          "required": false,
          "description": "实例ID列表，上限100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型： - CVM - Lighthouse - TAT 托管实例",
          "example": "[\"ins-xxxxxxxx\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "InvocationId"
      ]
    },
    {
      "name": "CreateCommand",
      "description": "此接口用于创建命令。",
      "status": "online",
      "parameters": [
        {
          "name": "CommandName",
          "type": "string",
          "required": true,
          "description": "命令名称。名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点，最大长度不能超60个字节。",
          "example": "tat-command"
        },
        {
          "name": "Content",
          "type": "string",
          "required": true,
          "description": "Base64编码后的命令内容，长度不可超过64KB。",
          "example": "cHdk"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "命令描述。不超过120字符。",
          "example": "this is a command"
        },
        {
          "name": "CommandType",
          "type": "string",
          "required": false,
          "description": "命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。",
          "example": "SHELL"
        },
        {
          "name": "WorkingDirectory",
          "type": "string",
          "required": false,
          "description": "命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:\\Program Files\\qcloud\\tat_agent\\workdir。",
          "example": "/root"
        },
        {
          "name": "Timeout",
          "type": "integer",
          "required": false,
          "description": "命令超时时间，默认60秒。取值范围[1, 86400]。",
          "example": "60"
        },
        {
          "name": "EnableParameter",
          "type": "boolean",
          "required": false,
          "description": "是否启用自定义参数功能。 一旦创建，此值不提供修改。 默认值：false。",
          "example": "false"
        },
        {
          "name": "DefaultParameters",
          "type": "string",
          "required": false,
          "description": "启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。 自定义参...",
          "example": "{\"varA\": \"222\"}"
        },
        {
          "name": "DefaultParameterConfs",
          "type": "array",
          "required": false,
          "description": "自定义参数数组。 如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 仅在 EnableParameter 参数为 true 时，才允许设置此参数。 自定义参数最多20个。",
          "example": "[ { \"ParameterName\": \"test01\",  \"ParameterValue\": \"12345\",  \"ParameterDescription\": \"for test01\"         }, {  \"ParameterName\": \"test02\", \"ParameterValue\": \"12345\",  \"ParameterDescription\": \"for test02\"}     ]",
          "item_type": "object",
          "children": [
            {
              "name": "ParameterName",
              "type": "string",
              "required": true,
              "description": "参数名。",
              "example": "name"
            },
            {
              "name": "ParameterValue",
              "type": "string",
              "required": true,
              "description": "参数默认值。",
              "example": "value"
            },
            {
              "name": "ParameterDescription",
              "type": "string",
              "required": false,
              "description": "参数描述。",
              "example": "This is a parameter."
            }
          ]
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "为命令关联的标签，列表长度不超过10。",
          "example": "[     {       \"Key\": \"test\",       \"Value\": \"test\"     }   ]",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "标签键。",
              "example": "tag-key"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "标签值。",
              "example": "tag-value"
            }
          ]
        },
        {
          "name": "Username",
          "type": "string",
          "required": false,
          "description": "在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。",
          "example": "root"
        },
        {
          "name": "OutputCOSBucketUrl",
          "type": "string",
          "required": false,
          "description": "指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。",
          "example": "https://BucketName-123454321.cos.ap-beijing.myqcloud.com"
        },
        {
          "name": "OutputCOSKeyPrefix",
          "type": "string",
          "required": false,
          "description": "指定日志在cos bucket中的目录，目录命名有如下规则： 1. 可用数字、中英文和可见字符的组合，长度最多为60。 2. 用 / 分割路径，可快速创建子目录。 3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称",
          "example": "aa/bb/cc"
        }
      ],
      "required": [
        "CommandName",
        "Content"
      ]
    },
    {
      "name": "CreateInvoker",
      "description": "此接口用于创建执行器。",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "执行器名称。长度不超过 120 字符。",
          "example": "invoker-test"
        },
        {
          "name": "Type",
          "type": "string",
          "required": true,
          "description": "执行器类型。 可选取值（当前仅支持一种）： - `SCHEDULE`：周期类型执行器。",
          "example": "SCHEDULE"
        },
        {
          "name": "CommandId",
          "type": "string",
          "required": true,
          "description": "远程命令ID。 可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。",
          "example": "cmd-k4ypdij0"
        },
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "触发器关联的实例ID。列表上限 100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。",
          "example": "[\"ins-yx05ky8j\"]",
          "item_type": "string"
        },
        {
          "name": "Username",
          "type": "string",
          "required": false,
          "description": "命令执行用户。长度不超过 256 字符。",
          "example": "root"
        },
        {
          "name": "Parameters",
          "type": "string",
          "required": false,
          "description": "命令自定义参数。字段类型为 JSON encode string。 仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。",
          "example": "{\"var\": \"A\"}"
        },
        {
          "name": "ScheduleSettings",
          "type": "object",
          "required": false,
          "description": "周期执行器设置。 当执行器类型为 `SCHEDULE` 时，必须指定此参数。",
          "example": "无",
          "children": [
            {
              "name": "Policy",
              "type": "string",
              "required": true,
              "description": "执行策略： - ONCE：单次执行 - RECURRENCE：周期执行",
              "example": "ONCE"
            },
            {
              "name": "Recurrence",
              "type": "string",
              "required": false,
              "description": "触发 Crontab 表达式。Policy 为 RECURRENCE 时，需要指定此字段。Crontab 按北京时间解析。",
              "example": "0 0 1 * *"
            },
            {
              "name": "InvokeTime",
              "type": "string",
              "required": false,
              "description": "执行器下次执行时间。Policy 为 ONCE 时，需要指定此字段。 时间格式为：YYYY-MM-DDThh:mm:ssZ",
              "example": "2021-09-01T00:00:00+08:00"
            }
          ]
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "为命令关联的标签，列表长度不超过10",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "标签键。",
              "example": "tag-key"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "标签值。",
              "example": "tag-value"
            }
          ]
        }
      ],
      "required": [
        "Name",
        "Type",
        "CommandId",
        "InstanceIds"
      ]
    },
    {
      "name": "CreateRegisterCode",
      "description": "接口用于创建注册码。",
      "status": "online",
      "parameters": [
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "注册码描述。最大长度为 128 字符。",
          "example": "此注册码用于注册托管实例。"
        },
        {
          "name": "InstanceNamePrefix",
          "type": "string",
          "required": false,
          "description": "注册实例名称前缀。最大长度为 32 字符。",
          "example": "register-test"
        },
        {
          "name": "RegisterLimit",
          "type": "integer",
          "required": false,
          "description": "该注册码允许注册的实例数目。默认值为 10，最小值为 1，最大值为 10000。",
          "example": "10"
        },
        {
          "name": "EffectiveTime",
          "type": "integer",
          "required": false,
          "description": "该注册码的有效时间，单位为小时。默认值为 4。 - 若传入值小于等于 99999，则以小时为单位设置有效时间。 - 若传入值大于 99999，则设置为长期有效。",
          "example": "4"
        },
        {
          "name": "IpAddressRange",
          "type": "string",
          "required": false,
          "description": "限制注册码只能从 IpAddressRange 所描述公网出口进行注册。 默认为空，即无任何限制。 取值应为标准 IPv4 或 CIDRv4 格式。例如 192.168.1.1 或 192.168.0.0/16。",
          "example": "133.12.234.0/24"
        }
      ],
      "required": []
    },
    {
      "name": "DeleteCommand",
      "description": "此接口用于删除命令。 如果命令与执行器关联，则无法被删除。",
      "status": "online",
      "parameters": [
        {
          "name": "CommandId",
          "type": "string",
          "required": true,
          "description": "待删除的命令 ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。",
          "example": "cmd-7efujjs6"
        }
      ],
      "required": [
        "CommandId"
      ]
    },
    {
      "name": "DeleteCommands",
      "description": "批量删除命令接口",
      "status": "online",
      "parameters": [
        {
          "name": "CommandIds",
          "type": "array",
          "required": true,
          "description": "待删除的命令 ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。",
          "example": "[\"cmd-0v4tysy3\",\"cmd-0v4tysy4\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "CommandIds"
      ]
    },
    {
      "name": "DeleteInvoker",
      "description": "此接口用于删除执行器。",
      "status": "online",
      "parameters": [
        {
          "name": "InvokerId",
          "type": "string",
          "required": true,
          "description": "待删除的执行器ID。 可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。",
          "example": "ivk-b7s3qa5l"
        }
      ],
      "required": [
        "InvokerId"
      ]
    },
    {
      "name": "DeleteRegisterCodes",
      "description": "此接口用于批量删除注册码。",
      "status": "online",
      "parameters": [
        {
          "name": "RegisterCodeIds",
          "type": "array",
          "required": true,
          "description": "注册码ID列表。限制输入的注册码ID数量大于0小于100。 可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。",
          "example": "[\"d0b7xxxx-a6xx-40x9-898x-44c9f508axxx\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "RegisterCodeIds"
      ]
    },
    {
      "name": "DeleteRegisterInstance",
      "description": "接口用于删除托管实例。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "托管实例ID。 可通过 [DescribeRegisterInstances(查询托管实例)](https://cloud.tencent.com/document/api/1340/96924) 接口获取。",
          "example": "[\"rins-8d5cxxxx\"]"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeAutomationAgentStatus",
      "description": "此接口用于查询自动化助手客户端的状态。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceIds",
          "type": "array",
          "required": false,
          "description": "待查询的实例ID列表。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 每次请求的上限为 100。 参数不支持同时指定 `InstanceIds ` 和 `Filters ` 。",
          "example": "[\"lhins-ar5wyn4x\"]",
          "item_type": "string"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "- agent-status - String - 是否必填：否 -（过滤条件）按照agent状态过滤，取值：Online 在线，Offline 离线。 - environment - String - 是否必填：否 -（过滤条件）按照agent运行环境查询，取值：Linux, Windows。 - instance-id - String - 是否必填：否 -（过滤条件）按照实例ID过滤。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 每次请求的 `Filters` 的...",
          "example": "[ { \"Name\": \"instance-id\", \"Values\": [\"ins-zcewfho0\"] }]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "需要过滤的字段。",
              "example": "command-type"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值。",
              "example": "[\"POWERSHELL\", \"BAT\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeCommands",
      "description": "此接口用于查询命令详情。",
      "status": "online",
      "parameters": [
        {
          "name": "CommandIds",
          "type": "array",
          "required": false,
          "description": "命令ID列表，每次请求的上限为100。参数不支持同时指定 `CommandIds` 和 `Filters` 。",
          "example": "[     \"cmd-2x8vxx0d\"   ]",
          "item_type": "string"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件。 - command-id - String - 是否必填：否 -（过滤条件）按照命令ID过滤。 - command-name - String - 是否必填：否 -（过滤条件）按照命令名称过滤。 - command-type - String - 是否必填：否 -（过滤条件）按照命令类型过滤，取值为 SHELL、POWERSHELL、BAT。 - scene-id - String - 是否必填：否 -（过滤条件）按照场景ID过滤。可通过 [DescribeScenes(查询场景)](https://cloud.tencent.com/document/api/1340/109968) \ufffd...",
          "example": "[ { \"Name\": \"command-id\", \"Values\": [\"cmd-nrncl292\"] } ]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "需要过滤的字段。",
              "example": "command-type"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值。",
              "example": "[\"POWERSHELL\", \"BAT\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeInvocationTasks",
      "description": "此接口用于查询执行任务详情。",
      "status": "online",
      "parameters": [
        {
          "name": "InvocationTaskIds",
          "type": "array",
          "required": false,
          "description": "执行任务ID列表，每次请求的上限为100。参数不支持同时指定 `InvocationTaskIds` 和 `Filters`。",
          "example": "[\"invt-xxxxxxxx\"]",
          "item_type": "string"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件。 - invocation-task-id - String - 是否必填：否 -（过滤条件）按照执行任务ID过滤。 - invocation-id - String - 是否必填：否 -（过滤条件）按照执行活动ID过滤。可通过 [DescribeInvocations(查询执行活动)](https://cloud.tencent.com/document/api/1340/52679) 接口获取。 - instance-id - String - 是否必填：否 -（过滤条件）按照实例ID过滤。可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类\ufffd...",
          "example": "[ { \"Name\": \"instance-id\", \"Values\": [\"ins-zcewfho0\"] } ]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "需要过滤的字段。",
              "example": "command-type"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值。",
              "example": "[\"POWERSHELL\", \"BAT\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
          "example": "0"
        },
        {
          "name": "HideOutput",
          "type": "boolean",
          "required": false,
          "description": "是否隐藏命令输出结果，取值范围： - true：隐藏输出 - false：不隐藏 默认为 true。",
          "example": "true"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeInvocations",
      "description": "此接口用于查询执行活动详情。",
      "status": "online",
      "parameters": [
        {
          "name": "InvocationIds",
          "type": "array",
          "required": false,
          "description": "执行活动ID列表，每次请求的上限为100。参数不支持同时指定 `InvocationIds` 和 `Filters`。",
          "example": "[\"inv-xxxxxxxx\"]",
          "item_type": "string"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件。 invocation-id - String - 是否必填：否 -（过滤条件）按照执行活动ID过滤。 command-id - String - 是否必填：否 -（过滤条件）按照命令ID过滤。 command-created-by - String - 是否必填：否 -（过滤条件）按照执行的命令类型过滤，取值为 TAT 或 USER，TAT 代表公共命令，USER 代表由用户创建的命令。 instance-kind - String - 是否必填：否 -（过滤条件）按照运行实例类型过滤，取值为 CVM 或 ...",
          "example": "[ { \"Name\": \"invocation-id\", \"Values\": [\"inv-zcewfho0\"] } ]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "需要过滤的字段。",
              "example": "command-type"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值。",
              "example": "[\"POWERSHELL\", \"BAT\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeInvokerRecords",
      "description": "此接口用于查询执行器的执行记录。",
      "status": "online",
      "parameters": [
        {
          "name": "InvokerIds",
          "type": "array",
          "required": false,
          "description": "执行器ID列表。列表上限 100。 可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。",
          "example": "[\"ivk-b7s3qa5l\"]",
          "item_type": "string"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为100。",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0。",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeInvokers",
      "description": "此接口用于查询执行器信息。",
      "status": "online",
      "parameters": [
        {
          "name": "InvokerIds",
          "type": "array",
          "required": false,
          "description": "执行器 ID 列表。 每次请求的上限为 100。 参数不支持同时指定 `InvokerIds ` 和 `Filters ` 。",
          "example": "[\"ivk-b7s3qa5l\"]",
          "item_type": "string"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件： - invoker-id - String - 是否必填：否 - （过滤条件）按执行器ID过滤。 - command-id - String - 是否必填：否 - （过滤条件）按命令ID过滤。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。 - invoker-type - String - 是否必填：否 - （过滤条件）按执行器类型过滤。目前仅支持 SCHEDULE 一种。 每次请求的 `Filters` 的上限为 10，`Filter.Values` 的上限\ufffd\ufffd...",
          "example": "[ { \"Name\": \"command-id\", \"Values\": [\"cmd-nrncl292\"] } ]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "需要过滤的字段。",
              "example": "command-type"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值。",
              "example": "[\"POWERSHELL\", \"BAT\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为100。",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0。",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeQuotas",
      "description": "此接口用于获取配额信息",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceNames",
          "type": "array",
          "required": true,
          "description": "资源名称 取值为： - COMMAND：命令 - REGISTER_CODE：托管实例注册码",
          "example": "[\"COMMAND\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "ResourceNames"
      ]
    },
    {
      "name": "DescribeRegions",
      "description": "此接口用于查询 TAT 产品后台地域列表。 RegionState 为 AVAILABLE，代表该地域的 TAT 后台服务已经可用；未返回，代表该地域的 TAT 后台服务尚不可用。",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeRegisterCodes",
      "description": "接口用于查询注册码信息。",
      "status": "online",
      "parameters": [
        {
          "name": "RegisterCodeIds",
          "type": "array",
          "required": false,
          "description": "注册码ID。 每次请求的上限为 100。 参数不支持同时指定 `RegisterCodeIds ` 和 `Filters ` 。",
          "example": "[\"d0b7xxxx-a6xx-40x9-898x-44c9f508axxx\"]",
          "item_type": "string"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为 0。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为 20，最大值为 100。",
          "example": "10"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeRegisterInstances",
      "description": "接口用于查询被托管的实例信息。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceIds",
          "type": "array",
          "required": false,
          "description": "托管实例 id。 每次请求的上限为 100。 参数不支持同时指定 `InstanceIds` 和 `Filters` 。",
          "example": "[\"rins-8d88xxxx\"]",
          "item_type": "string"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤器列表。每次请求的 `Filters` 的上限为 10，`Filter.Values` 的上限为 5。参数不支持同时指定 `InstanceIds` 和 `Filters` 。 - instance-name 按照【托管实例名称】进行过滤。 类型：String 必选：否 - instance-id 按照【托管实例ID】进行过滤。 类型：String 必选：否 - register-status 按照【托管实例状态】进行过滤，取值：Online | Offline。 类型：String 必选：否 - local-ip 按照【托管实例网卡IP】进\ufffd\ufffd...",
          "example": "[{\"name\":\"register-code-id\",\"value\":\"67c6df82-fa3e-48fb-9c17-07e3e1e9c2c3\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "需要过滤的字段。",
              "example": "command-type"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值。",
              "example": "[\"POWERSHELL\", \"BAT\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为 0。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为 20，最大值为 100。",
          "example": "10"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeScenes",
      "description": "此接口用于查询场景详情。",
      "status": "online",
      "parameters": [
        {
          "name": "SceneIds",
          "type": "array",
          "required": false,
          "description": "场景 ID 数组。 每次请求的上限为 100。 参数不支持同时指定 `SceneIds ` 和 `Filters ` 。",
          "example": "[\"sc-12345678\"]",
          "item_type": "string"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件。 - scene-id - String - 是否必填：否 -（过滤条件）按照场景 ID 过滤。 - scene-name - String - 是否必填：否 -（过滤条件）按照场景名称过滤。 - created-by - String - 是否必填：否 -（过滤条件）按照场景创建者过滤，目前仅支持 TAT，代表公共场景。 每次请求的 `Filters` 的上限为10， `Filter.Values` 的上限为5。参数不支持同时指定 `SceneIds` 和 `Filters` 。",
          "example": "{\"scene-id\": \"sc-12345678\"}",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "需要过滤的字段。",
              "example": "command-type"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值。",
              "example": "[\"POWERSHELL\", \"BAT\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
          "example": "20"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "DisableInvoker",
      "description": "此接口用于停止执行器。",
      "status": "online",
      "parameters": [
        {
          "name": "InvokerId",
          "type": "string",
          "required": true,
          "description": "待停止的执行器ID。 可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。",
          "example": "ivk-b7s3qa5l"
        }
      ],
      "required": [
        "InvokerId"
      ]
    },
    {
      "name": "DisableRegisterCodes",
      "description": "此接口用于批量禁用注册码。",
      "status": "online",
      "parameters": [
        {
          "name": "RegisterCodeIds",
          "type": "array",
          "required": true,
          "description": "注册码ID。 可通过 [DescribeRegisterCodes(查询注册码)](https://cloud.tencent.com/document/api/1340/96925) 接口获取。",
          "example": "[\"d0b7xxxx-a6xx-40x9-898x-44c9f508axxx\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "RegisterCodeIds"
      ]
    },
    {
      "name": "EnableInvoker",
      "description": "此接口用于启用执行器。",
      "status": "online",
      "parameters": [
        {
          "name": "InvokerId",
          "type": "string",
          "required": true,
          "description": "待启用的执行器ID。 可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。",
          "example": "ivk-b7s3qa5l"
        }
      ],
      "required": [
        "InvokerId"
      ]
    },
    {
      "name": "InvokeCommand",
      "description": "在指定的实例上触发命令，调用成功返回执行活动ID（inv-xxxxxxxx），每个执行活动内部有一个或多个执行任务（invt-xxxxxxxx），每个执行任务代表命令在一台 CVM 或一台 Lighthouse 上的执行记录。 * 如果指定实例未安装 agent，或 agent 不在线，返回失败 * 如果命令类型与 agent 运行环境不符，返回失败 * 指定的实例需要处于 VPC 网络 * 指定的实例需要处于 RUNNING 状态 * 不可同时指定 CVM ...",
      "status": "online",
      "parameters": [
        {
          "name": "CommandId",
          "type": "string",
          "required": true,
          "description": "待触发的命令ID。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。",
          "example": "cmd-ffxdx79i"
        },
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "待执行命令的实例ID列表，上限200。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型： - CVM - Lighthouse - TAT 托管实例",
          "example": "[\"lhins-ar5wyn40\"]",
          "item_type": "string"
        },
        {
          "name": "Parameters",
          "type": "string",
          "required": false,
          "description": "Command 的自定义参数。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 或 DefaultParameterConfs...",
          "example": "{\"varA\": \"222\"}"
        },
        {
          "name": "Username",
          "type": "string",
          "required": false,
          "description": "在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。若不填，默认以 Command 配置的 Username 执行。",
          "example": "root"
        },
        {
          "name": "WorkingDirectory",
          "type": "string",
          "required": false,
          "description": "命令执行路径, 默认以Command配置的WorkingDirectory执行。",
          "example": "/root"
        },
        {
          "name": "Timeout",
          "type": "integer",
          "required": false,
          "description": "命令超时时间，取值范围[1, 86400]。默认以Command配置的Timeout执行。",
          "example": "60"
        },
        {
          "name": "OutputCOSBucketUrl",
          "type": "string",
          "required": false,
          "description": "指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。",
          "example": "https://BucketName-123454321.cos.ap-beijing.myqcloud.com"
        },
        {
          "name": "OutputCOSKeyPrefix",
          "type": "string",
          "required": false,
          "description": "指定日志在cos bucket中的目录，目录命名有如下规则： 1. 可用数字、中英文和可见字符的组合，长度最多为60。 2. 用 / 分割路径，可快速创建子目录。 3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。",
          "example": "aa/bb/cc"
        }
      ],
      "required": [
        "CommandId",
        "InstanceIds"
      ]
    },
    {
      "name": "ModifyCommand",
      "description": "此接口用于修改命令。",
      "status": "online",
      "parameters": [
        {
          "name": "CommandId",
          "type": "string",
          "required": true,
          "description": "命令ID。可通过 DescribeCommands(查询命令详情) 接口获取。",
          "example": "cmd-7efujjs6"
        },
        {
          "name": "CommandName",
          "type": "string",
          "required": false,
          "description": "命令名称。名称仅支持中文、英文、数字、下划线、分隔符\u0026quot;-\u0026quot;、小数点，最大长度不能超60个字节。",
          "example": "tat-command"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "命令描述。不超过120字符。",
          "example": "this is a command"
        },
        {
          "name": "Content",
          "type": "string",
          "required": false,
          "description": "Base64编码后的命令内容，长度不可超过64KB。",
          "example": "cHdk"
        },
        {
          "name": "CommandType",
          "type": "string",
          "required": false,
          "description": "命令类型，目前支持取值：SHELL、POWERSHELL、BAT。",
          "example": "SHELL"
        },
        {
          "name": "WorkingDirectory",
          "type": "string",
          "required": false,
          "description": "命令执行路径。",
          "example": "/root"
        },
        {
          "name": "Timeout",
          "type": "integer",
          "required": false,
          "description": "命令超时时间。取值范围：[1, 86400]单位：秒默认值：60指定 OutputCOSBucketUrl 参数时，超时时间将包含命令输出上传 COS 的耗时",
          "example": "60"
        },
        {
          "name": "DefaultParameters",
          "type": "string",
          "required": false,
          "description": "启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\u0026quot;varA\u0026quot;: \u0026quot;222\u0026quot;}。参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。采取整体全覆盖式修改，即修改时必须提供所有新默认值。仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。key为自定义参数名称，va...",
          "example": "{\"varA\": \"222\"}"
        },
        {
          "name": "DefaultParameterConfs",
          "type": "array",
          "required": false,
          "description": "自定义参数数组。如果 InvokeCommand 时未提供参数取值，将使用这里的默认值进行替换。参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。仅在命令的 EnableParameter 为 true 时，才允许修改此参数。可通过 DescribeCommands(查询命令详情) 接口获取命令的 EnableParameter 设置。自定义参数最多20个。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ParameterName",
              "type": "string",
              "required": true,
              "description": "参数名。",
              "example": "name"
            },
            {
              "name": "ParameterValue",
              "type": "string",
              "required": true,
              "description": "参数默认值。",
              "example": "value"
            },
            {
              "name": "ParameterDescription",
              "type": "string",
              "required": false,
              "description": "参数描述。",
              "example": "This is a parameter."
            }
          ]
        },
        {
          "name": "Username",
          "type": "string",
          "required": false,
          "description": "在 CVM 或 Lighthouse 实例中执行命令的用户名称。使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。",
          "example": "root"
        },
        {
          "name": "OutputCOSBucketUrl",
          "type": "string",
          "required": false,
          "description": "指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。",
          "example": "https://BucketName-123454321.cos.ap-beijing.myqcloud.com"
        },
        {
          "name": "OutputCOSKeyPrefix",
          "type": "string",
          "required": false,
          "description": "指定日志在cos bucket中的目录，目录命名有如下规则：可用数字、中英文和可见字符的组合，长度最多为60。用 / 分割路径，可快速创建子目录。不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。",
          "example": "aa/bb/cc"
        }
      ],
      "required": [
        "CommandId"
      ]
    },
    {
      "name": "ModifyInvoker",
      "description": "此接口用于修改执行器。",
      "status": "online",
      "parameters": [
        {
          "name": "InvokerId",
          "type": "string",
          "required": true,
          "description": "待修改的执行器ID。 可通过 [DescribeInvokers(查询执行器)](https://cloud.tencent.com/document/api/1340/61759) 接口获取。",
          "example": "ivk-n0t6rxtv"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "待修改的执行器名称。长度不超过 120 字符。",
          "example": "invoker-test"
        },
        {
          "name": "Type",
          "type": "string",
          "required": false,
          "description": "待修改的执行器类型。 可选取值（当前仅支持一种）： - `SCHEDULE`：周期类型执行器。",
          "example": "SCHEDULE"
        },
        {
          "name": "CommandId",
          "type": "string",
          "required": false,
          "description": "待修改的命令ID。 可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。",
          "example": "cmd-m7uma92n"
        },
        {
          "name": "Username",
          "type": "string",
          "required": false,
          "description": "待修改的用户名。长度不超过 256 字符。",
          "example": "root"
        },
        {
          "name": "Parameters",
          "type": "string",
          "required": false,
          "description": "待修改的自定义参数。字段类型为 JSON encode string。 仅在 CommandId 所指命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。",
          "example": "{\"var\": \"A\"}"
        },
        {
          "name": "InstanceIds",
          "type": "array",
          "required": false,
          "description": "待修改的实例ID列表。列表长度上限100。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型：CVM、Lighthouse、TAT 托管实例。 实例需要安装 TAT 客户端, 且客户端为 Online 状态。可通过 [DescribeAutomationAgentStatus(查询客户端状态)](https://cloud.tencent.com/document/api/1340/52682) 接口查询客户端状态。",
          "example": "[\"ins-yx05ky8j\"]",
          "item_type": "string"
        },
        {
          "name": "ScheduleSettings",
          "type": "object",
          "required": false,
          "description": "待修改的周期执行器设置。 要将执行器类型修改为 `SCHEDULE` 时，必须指定此参数。",
          "example": "{          \"Policy\":\"ONCE\",     \"InvokeTime\":\"2021-09-01T00:00:00+08:00\" }",
          "children": [
            {
              "name": "Policy",
              "type": "string",
              "required": true,
              "description": "执行策略： - ONCE：单次执行 - RECURRENCE：周期执行",
              "example": "ONCE"
            },
            {
              "name": "Recurrence",
              "type": "string",
              "required": false,
              "description": "触发 Crontab 表达式。Policy 为 RECURRENCE 时，需要指定此字段。Crontab 按北京时间解析。",
              "example": "0 0 1 * *"
            },
            {
              "name": "InvokeTime",
              "type": "string",
              "required": false,
              "description": "执行器下次执行时间。Policy 为 ONCE 时，需要指定此字段。 时间格式为：YYYY-MM-DDThh:mm:ssZ",
              "example": "2021-09-01T00:00:00+08:00"
            }
          ]
        }
      ],
      "required": [
        "InvokerId"
      ]
    },
    {
      "name": "ModifyRegisterInstance",
      "description": "接口用于修改托管实例信息。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "托管实例ID。 可通过 [DescribeRegisterInstances(查询托管实例)](https://cloud.tencent.com/document/api/1340/96924) 接口获取。",
          "example": "rins-8dz6cwxx"
        },
        {
          "name": "InstanceName",
          "type": "string",
          "required": true,
          "description": "实例名称。有效长度为 1～60 字符。",
          "example": "register-test"
        }
      ],
      "required": [
        "InstanceId",
        "InstanceName"
      ]
    },
    {
      "name": "PreviewReplacedCommandContent",
      "description": "此接口用于预览自定义参数替换后的命令内容。不会触发真实执行。",
      "status": "online",
      "parameters": [
        {
          "name": "Parameters",
          "type": "string",
          "required": false,
          "description": "本次预览采用的自定义参数。字段类型为 json encoded string，如：{\"varA\": \"222\"}。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取命令的 EnableParameter 设置。 如果有设置过 DefaultParameters 或 DefaultParameterConfs，会与 Parameters 进行叠加，优先使用 Parameters 的值。 key 为自定义参数名称，value 为该\ufffd...",
          "example": "{\"varA\": \"222\"}"
        },
        {
          "name": "CommandId",
          "type": "string",
          "required": false,
          "description": "要进行替换预览的命令。 可通过 [DescribeCommands(查询命令详情)](https://cloud.tencent.com/document/api/1340/52681) 接口获取。 CommandId 与 Content，必须且只能提供一个。",
          "example": "cmd-abcdefgh"
        },
        {
          "name": "Content",
          "type": "string",
          "required": false,
          "description": "要预览的命令内容，经 Base64 编码，长度不可超过 64KB。 CommandId 与 Content，必须且只能提供一个。",
          "example": "bHMge3thfX0KZWNobyB7e2J9fQ=="
        }
      ],
      "required": []
    },
    {
      "name": "RunCommand",
      "description": "执行命令，调用成功返回执行活动ID（inv-xxxxxxxx），每个执行活动内部有一个或多个执行任务（invt-xxxxxxxx），每个执行任务代表命令在一台 CVM 或一台 Lighthouse 上的执行记录。 * 如果指定实例未安装 agent，或 agent 不在线，返回失败 * 如果命令类型与 agent 运行环境不符，返回失败 * 指定的实例需要处于 VPC 网络 * 指定的实例需要处于 `RUNNING` 状态 * 不可同时指定 CVM 和 Lighthouse",
      "status": "online",
      "parameters": [
        {
          "name": "Content",
          "type": "string",
          "required": true,
          "description": "Base64编码后的命令内容，长度不可超过64KB。",
          "example": "cHdk"
        },
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "待执行命令的实例ID列表，上限200。 可通过对应云产品的查询实例接口获取实例 ID。目前支持实例类型： - CVM - Lighthouse - TAT 托管实例",
          "example": "[\"ins-zcxx4ga1\"]",
          "item_type": "string"
        },
        {
          "name": "CommandName",
          "type": "string",
          "required": false,
          "description": "命令名称。名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点，最大长度不能超60个字节。",
          "example": "tat-command"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "命令描述。不超过120字符。",
          "example": "this is a command"
        },
        {
          "name": "CommandType",
          "type": "string",
          "required": false,
          "description": "命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。",
          "example": "SHELL"
        },
        {
          "name": "WorkingDirectory",
          "type": "string",
          "required": false,
          "description": "命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:\\Program Files\\qcloud\\tat_agent\\workdir。",
          "example": "/root"
        },
        {
          "name": "Timeout",
          "type": "integer",
          "required": false,
          "description": "命令超时时间，默认60秒。取值范围[1, 86400]。",
          "example": "60"
        },
        {
          "name": "SaveCommand",
          "type": "boolean",
          "required": false,
          "description": "是否保存命令，取值范围： true：保存 false：不保存 默认为 false。",
          "example": "false"
        },
        {
          "name": "EnableParameter",
          "type": "boolean",
          "required": false,
          "description": "是否启用自定义参数功能。 一旦创建，此值不提供修改。 取值范围： true：启用 false：不启用 默认值：false。",
          "example": "false"
        },
        {
          "name": "DefaultParameters",
          "type": "string",
          "required": false,
          "description": "启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。 如果 Parameters 未提供，将使用这里的默认值进行替换。 自定义参数最多20个。 自定义参数名称需\ufffd...",
          "example": "{\"varA\": \"222\"}"
        },
        {
          "name": "DefaultParameterConfs",
          "type": "array",
          "required": false,
          "description": "自定义参数数组。 如果 Parameters 未提供，将使用这里的默认值进行替换。 自定义参数最多20个。 如果 Parameters 未提供，将使用这里的默认值进行替换。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。 参数不支持同时指定 `DefaultParameters` 和 `DefaultParameterConfs` 。",
          "example": "[ { \"ParameterName\": \"test01\",  \"ParameterValue\": \"12345\",  \"ParameterDescription\": \"for test01\"         }, {  \"ParameterName\": \"test02\", \"ParameterValue\": \"12345\",  \"ParameterDescription\": \"for test02\"}     ]",
          "item_type": "object",
          "children": [
            {
              "name": "ParameterName",
              "type": "string",
              "required": true,
              "description": "参数名。",
              "example": "name"
            },
            {
              "name": "ParameterValue",
              "type": "string",
              "required": true,
              "description": "参数默认值。",
              "example": "value"
            },
            {
              "name": "ParameterDescription",
              "type": "string",
              "required": false,
              "description": "参数描述。",
              "example": "This is a parameter."
            }
          ]
        },
        {
          "name": "Parameters",
          "type": "string",
          "required": false,
          "description": "Command 的自定义参数。字段类型为json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 仅在命令的 EnableParameter 为 true 时，才允许设置此参数。 如果未提供该参数取值，将使用 DefaultParameters 或 DefaultParameterConfs 进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。",
          "example": "{\"varA\": \"222\"}"
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "如果保存命令，可为命令设置标签。列表长度不超过10。",
          "example": "[     {       \"Key\": \"test\",       \"Value\": \"test\"     }   ]",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "标签键。",
              "example": "tag-key"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "标签值。",
              "example": "tag-value"
            }
          ]
        },
        {
          "name": "Username",
          "type": "string",
          "required": false,
          "description": "在 CVM 或 Lighthouse 实例中执行命令的用户名称。 使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。",
          "example": "root"
        },
        {
          "name": "OutputCOSBucketUrl",
          "type": "string",
          "required": false,
          "description": "指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。",
          "example": "https://BucketName-123454321.cos.ap-beijing.myqcloud.com"
        },
        {
          "name": "OutputCOSKeyPrefix",
          "type": "string",
          "required": false,
          "description": "指定日志在cos bucket中的目录，目录命名有如下规则： 1. 可用数字、中英文和可见字符的组合，长度最多为60。 2. 用 / 分割路径，可快速创建子目录。 3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称。",
          "example": "aa/bb/cc"
        }
      ],
      "required": [
        "Content",
        "InstanceIds"
      ]
    }
  ]
}