查询指定配置组的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。该功能无地域属性，该字段固定填写 枚举值：
|
cn-shanghai |
| GroupId |
string |
是 |
配置组 ID。 |
cg-hs3i1w39o68ma**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| Data |
object |
配置组信息。 |
|
| GroupId |
string |
配置组 ID。 |
cg-75aazkg2tnqb2***** |
| Name |
string |
配置组名称。 |
定时任务 |
| Description |
string |
配置组描述信息。 |
定时任务 |
| Type |
string |
配置组类型。 枚举值：
|
Timer |
| ProductType |
string |
配置组使用的产品类型。 枚举值：
|
CLOUD_DESKTOP |
| ConfigTimers |
array<object> |
定时任务的配置信息，列表结构。 |
|
|
array<object> |
定时任务的配置信息。 |
||
| TimerType |
string |
定时任务类型。 枚举值：
|
TimerBoot |
| CronExpression |
string |
定时任务 Cron 表达式。 |
0 0 16 ? * 1,2,3,4,5,6,7 |
| Interval |
integer |
时间间隔，单位为分钟。 |
10 |
| Enforce |
boolean |
是否强制执行。为 true 表示忽略桌面及连接状态检测，强制执行定时任务。 |
false |
| ResetType |
string |
重置定时任务重置类型。 枚举值：
|
RESET_TYPE_SYSTEM |
| AllowClientSetting |
boolean |
是否允许终端用户自行配置定时任务。 |
true |
| OperationType |
string |
断连定时任务类型。 枚举值：
|
Shutdown |
| TriggerType |
string |
无操作定时任务触发配置类型。 枚举值：
|
Standard |
| ProcessWhitelist |
array |
无操作定时任务智能判断的进程白名单，如果指定的进程正在运行则不支持无操作定时任务。 |
|
|
string |
进程名称。 |
chrome |
|
| NotificationTime |
integer |
||
| SegmentTimers |
array<object> |
||
|
object |
|||
| StartCronExpression |
string |
||
| EndCronExpression |
string |
||
| OperationType |
string |
||
| Interval |
integer |
||
| TriggerType |
string |
||
| ProcessWhitelist |
array |
||
|
string |
|||
| NotificationTime |
integer |
||
| TimerOrder |
integer |
||
| Timezone |
string |
||
| Enforce |
boolean |
||
| ResetType |
string |
||
| ImageId |
string |
变更镜像定时任务使用，指定需要变更的镜像 ID |
m-5b0vjqbiqu010XXXXXX |
| LockScreenTime |
integer |
无操作锁屏功能使用，指定锁屏时间点，非 AD 桌面不能使用 |
1800 |
| AppointmentTimer |
integer |
定点执行定时任务使用，指定后可以按照指定时间点执行定时任务 |
1764660600967 |
| BindCount |
integer |
配置组绑定的资源数。 |
50 |
| Status |
string |
配置组状态。 枚举值：
|
AVAILABLE |
| BindCountMap |
object |
配置绑定资源的数量信息。 |
|
|
integer |
绑定资源的数量。 |
10 |
|
| IsBind |
boolean |
系统定时任务检查使用，当前定时任务不支持解绑和绑定 |
|
| IsUpdate |
boolean |
系统定时任务检查使用，当前定时任务不支持修改 |
|
| InnerTimerName |
string |
前端展示使用，系统定时任务名称映射 code |
INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE |
| InnerTimerDesc |
string |
前端展示使用，系统定时任务描述使用 code |
INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC |
示例
正常返回示例
JSON格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"Data": {
"GroupId": "cg-75aazkg2tnqb2*****",
"Name": "定时任务",
"Description": "定时任务",
"Type": "Timer",
"ProductType": "CLOUD_DESKTOP",
"ConfigTimers": [
{
"TimerType": "TimerBoot",
"CronExpression": "0 0 16 ? * 1,2,3,4,5,6,7\n",
"Interval": 10,
"Enforce": false,
"ResetType": "RESET_TYPE_SYSTEM",
"AllowClientSetting": true,
"OperationType": "Shutdown",
"TriggerType": "Standard",
"ProcessWhitelist": [
"chrome"
],
"NotificationTime": 0,
"SegmentTimers": [
{
"StartCronExpression": "",
"EndCronExpression": "",
"OperationType": "",
"Interval": 0,
"TriggerType": "",
"ProcessWhitelist": [
""
],
"NotificationTime": 0,
"TimerOrder": 0,
"Timezone": "",
"Enforce": true,
"ResetType": "",
"ImageId": "m-5b0vjqbiqu010XXXXXX",
"LockScreenTime": 1800,
"AppointmentTimer": 1764660600967
}
]
}
],
"BindCount": 50,
"Status": "AVAILABLE",
"BindCountMap": {
"key": 10
},
"IsBind": true,
"IsUpdate": true,
"InnerTimerName": "INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE",
"InnerTimerDesc": "INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。