创建运维任务

最近更新时间:2025-04-11 01:10:45

我的收藏

1. 接口描述

接口请求域名: bh.tencentcloudapi.com 。

创建运维任务

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateOperationTask。
Version String 公共参数,本接口取值:2023-04-18。
Region String 公共参数,详见产品支持的 地域列表
Name String 运维任务名称
示例值:runshell
Type Integer 运维任务类型,1 - 手工执行, 2 - 周期性自动执行
示例值:1
Account String 执行账号
示例值:root
Timeout Integer 超时时间,单位秒
示例值:5
Script String 执行脚本内容
示例值:ls -a
DeviceIdSet.N Array of Integer 执行主机集合,满足条件以下三个条件:1. 资产绑定可用的专业版或国密版堡垒机服务;2、资产类型为linux资产;3、用户具有资产权限,且资产添加了指定执行账号
示例值:[13,25]
Period Integer 执行间隔,单位天. 手工执行时无需传入
示例值:1
FirstTime Timestamp ISO8601 首次执行日期 默认1970-01-01T08:00:01+08:00,手工执行时无需传入
示例值:1970-01-01T08:00:01+08:00
Encoding Integer Script参数是否需要进行base64编码后传递,1-需要进行base64编码后传递,非1值-不需要进行base64编码后传递
示例值:1

3. 输出参数

参数名称 类型 描述
TaskId Integer 运维任务ID
示例值:2
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建周期性运维任务

输入示例

复制
复制成功
POST / HTTP/1.1
Host: bh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateOperationTask
<公共请求参数>

{
    "Name": "周期运维任务",
    "Type": 2,
    "Period": 1,
    "FirstTime": "2025-03-25T08:00:01+08:00",
    "Account": "root",
    "Timeout": 5,
    "Script": "ls",
    "Encoding": 1,
    "DeviceIdSet": [
        34,
        56
    ]
}

输出示例

复制
复制成功
{
    "Response": {
        "TaskId": 10,
        "RequestId": "31js-hapqhxmaj-h12knsk2weq"
    }
}

示例2 创建运维任务

输入示例

复制
复制成功
POST / HTTP/1.1
Host: bh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateOperationTask
<公共请求参数>

{
    "Name": "运维任务",
    "Type": 1,
    "Account": "root",
    "Timeout": 5,
    "Script": "ls -al",
    "Encoding": 0,
    "DeviceIdSet": [
        44,
        66
    ]
}

输出示例

复制
复制成功
{
    "Response": {
        "TaskId": 11,
        "RequestId": "31sfasw-ewffq-wesvfxvd"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DataNotFound FailedOperation.DataNotFound
FailedOperation.ResourceNotPro 非专业版资源
FailedOperation.UserExpired 用户已过期
FailedOperation.UserInvalid 用户未生效
FailedOperation.UserLocked 用户已锁定
FailedOperation.UserNotExist 用户不存在
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。

如果遇到产品相关问题,您可咨询 在线客服 寻求帮助。

返回顶部
可通过正文划词反馈文档内容问题,我们会快速处理并更新文档内容。