创建软件分发任务
接口说明
任务创建后初始状态为 disabled（关闭）。
MatchMode 决定匹配目标参数的填写方式：为 UserGroupNormal 时必须且只能传 UserGroupIds，为 DeviceGroupNormal 时必须且只能传 DeviceGroupIds，为 DevTagNormal 时必须且只能传 DevTags；传入与 MatchMode 不匹配的参数将被拒绝。
SupportOs 仅支持传入单个操作系统。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Name |
string |
是 |
任务名称。长度为 1~64 个字符。 |
test_task |
| SoftwareId |
string |
否 |
软件库中的软件 ID。取值来源： ListSoftwarelibSoftware 。 |
softwarelib-software-9f9de7b5a16f**** |
| SupportOs |
string |
否 |
任务适用的操作系统，仅支持单个取值。取值：
枚举值：
|
Mac(Apple) |
| ExecuteMode |
string |
否 |
执行模式。取值：
枚举值：
|
Once |
| ExecuteParameters |
string |
否 |
调度执行参数，JSON 格式字符串。 |
{ "template_code": "software_install", "software_url": "https://****", "md5": "87ccfcce1956e9f2385137f690d7fb64", "install_check_switch": false, "software_name": "", "software_name_en": "", "speed_limit": 0, "software_id": "softwarelib-software-18a2417da2779e65" } |
| ExecutePeriod |
string |
否 |
任务执行周期，JSON 格式字符串。其中 validType 表示周期类型，取值：
|
{"validType":"Once"} |
| MatchMode |
string |
否 |
策略匹配目标类型。取值：
枚举值：
|
UserGroupAll |
| UserGroupIds |
array |
否 |
用户组 ID 集合，不允许重复。MatchMode 为 UserGroupNormal 时必填且至少传入 1 个；MatchMode 为其他取值时不允许传入，否则请求被拒绝。取值来源： ListUserGroups 。 |
|
|
string |
否 |
用户组 ID。 |
usergroup-413d657ac967**** |
|
| DeviceGroupIds |
array |
否 |
设备组 ID 集合，不允许重复。MatchMode 为 DeviceGroupNormal 时必填；MatchMode 为其他取值时不允许传入，否则请求被拒绝。取值来源： ListDeviceGroups 。 |
|
|
string |
否 |
设备组 ID。 |
device-group-5191cf830a5e**** |
|
| DevTags |
array |
否 |
终端设备 ID 集合，不允许重复，单个 ID 长度不超过 1000 个字符。MatchMode 为 DevTagNormal 时必填；MatchMode 为其他取值时不允许传入，否则请求被拒绝。 |
|
|
string |
否 |
待添加的终端设备 ID。 |
2fd97d9d-9278-fb79-daa0-b27147eb**** |
|
| GmtExpired |
string |
否 |
任务过期时间，毫秒级 Unix 时间戳。仅在 ExpireMode 为 Expire 时生效。 |
1786945543000 |
| RetryTimes |
string |
否 |
任务失败后的重试次数。 |
5 |
| Timeout |
string |
否 |
任务执行超时时间，单位：秒。例如取值 3600 表示 1 小时。 |
3600 |
| ExpireMode |
string |
否 |
过期类型。取值：
|
Expire |
| VersionId |
string |
否 |
待分发的软件版本 ID。取值来源： ListSoftwarelibVersion 。 |
softwarelib-version-30925615d2e4**** |
| TaskType |
string |
否 |
任务类型。取值：
|
server |
| SoftwareName |
string |
否 |
软件名称。长度不超过 128 个字符。 |
test software |
| RunAsAccount |
string |
否 |
Windows 系统下用于执行任务的管理员账号名称。长度不超过 128 个字符。 |
admin |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
B608C6AE-623D-55C4-9454-601B88AE937E |
| Task |
object |
创建成功的任务信息。 |
|
| TaskId |
string |
任务 ID，用于查询任务执行结果。 |
softwarelib-distribute-task-911dd7898bc2**** |
| Name |
string |
任务名称。 |
test_task |
| Status |
string |
任务状态。取值：
任务创建后初始状态为 disabled。 枚举值：
|
disabled |
| SoftwareName |
string |
软件名称 |
test software |
| SupportOs |
string |
任务适用的操作系统。取值：
枚举值：
|
Windows |
| CreateTime |
string |
任务创建时间，秒级 Unix 时间戳。 |
1782268092 |
示例
正常返回示例
JSON格式
{
"RequestId": "B608C6AE-623D-55C4-9454-601B88AE937E",
"Task": {
"TaskId": "softwarelib-distribute-task-911dd7898bc2****",
"Name": "test_task",
"Status": "disabled",
"SoftwareName": "test software",
"SupportOs": "Windows",
"CreateTime": "1782268092"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。