DescribeTimerGroup查询定时任务配置组详细信息-无影云电脑企业版-阿里云-无影云电脑企业版-阿里云帮助中心

查询指定配置组的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeTimerGroup

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。该功能无地域属性，该字段固定填写`cn-shanghai`。枚举值： cn-shanghai : cn-shanghai	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 : 定时任务	Timer
ProductType	string	配置组使用的产品类型。枚举值： CLOUD_DESKTOP : 云电脑	CLOUD_DESKTOP
ConfigTimers	array<object>	定时任务的配置信息，列表结构。
	array<object>	定时任务的配置信息。
TimerType	string	定时任务类型。枚举值： NoOperationDisconnect : 无操作断连 NoConnect : 断连任务（需指定 OperationType） TimerBoot : 定时开机 TimerReset : 定时重置 NoOperationShutdown : 无操作关机 NoOperationHibernate : 无操作休眠 TimerShutdown : 定时关机 NoOperationReboot : 无操作重启 TimerReboot : 定时重启	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 : 重置系统盘 RESET_TYPE_USER_DISK : 重置数据盘 RESET_TYPE_BOTH : 重置系统盘和数据盘	RESET_TYPE_SYSTEM
AllowClientSetting	boolean	是否允许终端用户自行配置定时任务。	true
OperationType	string	断连定时任务类型。枚举值： Hibernate : 休眠 Shutdown : 关机	Shutdown
TriggerType	string	无操作定时任务触发配置类型。枚举值： Advanced : 智能判断 Standard : 标准判断	Standard
ProcessWhitelist	array	无操作定时任务智能判断的进程白名单，如果指定的进程正在运行则不支持无操作定时任务。
	string	进程名称。	chrome
NotificationTime	integer	定时任务执行前的通知提前时间。单位：秒。	300
SegmentTimers	array<object>	分段定时器配置列表。
	object
StartCronExpression	string	定时任务开始执行的 Cron 表达式。	0 0 8 ? * 1-5
EndCronExpression	string	定时任务结束执行的 Cron 表达式。	0 0 18 ? * 1-5
OperationType	string	定时任务操作类型，目前仅断连定时任务支持。	Shutdown
Interval	integer	时间间隔，单位为分钟。	10
TriggerType	string	无操作定时任务触发配置类型。	Standard
ProcessWhitelist	array	无操作定时任务智能判断的进程白名单，如果指定的进程正在运行则不支持无操作定时任务。
	string	进程白名单，名单内进程运行时定时任务不生效。	chrome.exe
NotificationTime	integer	定时任务执行前的通知提前时间。单位：秒。	300
TimerOrder	integer	定时器的执行顺序号。	1
Timezone	string	定时任务使用的时区。	Asia/Shanghai
Enforce	boolean	是否强制执行。为 true 表示忽略桌面及连接状态检测，强制执行定时任务。
ResetType	string	重置类型，决定是否重置，以及要重置的磁盘范围。	1
ImageId	string	变更镜像定时任务使用，指定需要变更的镜像 ID	m-5b0vjqbiqu010XXXXXX
LockScreenTime	integer	无操作锁屏功能使用，指定无操作后触发锁屏的时长。单位：分钟。仅 AD 云电脑支持。	5
AppointmentTimer	integer	定点执行定时任务使用，指定后可以按照指定时间点执行定时任务	1764660600967
PatchId	string	补丁 ID	KB5082063
CreateSnapshot	boolean	是否创建快照
VerificationTime	integer	校验等待时长。单位：秒。	600
VerificationNotificationTime	integer	执行校验前的通知提前时间。单位：秒。	300
IpSegments	array	生效的 IP 网段列表。
	string	生效的 IP 网段列表。	192.168.1.0/24
BindCount	integer	配置组绑定的资源数。	50
Status	string	配置组状态。枚举值： AVAILABLE : 可用 UNAVAILABLE : 已删除 DELETING : 删除中 UPDATING : 修改中	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": 300,
        "SegmentTimers": [
          {
            "StartCronExpression": "0 0 8 ? * 1-5",
            "EndCronExpression": "0 0 18 ? * 1-5",
            "OperationType": "Shutdown",
            "Interval": 10,
            "TriggerType": "Standard",
            "ProcessWhitelist": [
              "chrome.exe"
            ],
            "NotificationTime": 300,
            "TimerOrder": 1,
            "Timezone": "Asia/Shanghai",
            "Enforce": true,
            "ResetType": "1",
            "ImageId": "m-5b0vjqbiqu010XXXXXX",
            "LockScreenTime": 5,
            "AppointmentTimer": 1764660600967,
            "PatchId": "KB5082063",
            "CreateSnapshot": true,
            "VerificationTime": 600,
            "VerificationNotificationTime": 300,
            "IpSegments": [
              "192.168.1.0/24"
            ]
          }
        ]
      }
    ],
    "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"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。