使用DescribeGlobalTimerRecords查询全局定时任务执行记录-无影云电脑企业版-阿里云-无影云电脑企业版-阿里云帮助中心

查询各地域云电脑的定时任务执行记录。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeGlobalTimerRecords

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-shanghai
TimerTypes	array	否	定时任务列表。	cn-shanghai
	string	否	定时任务类型。定时任务： TimerBoot：定时开机 TimerShutdown：定时关机 TimerReboot：定时重启 TimerReset：定时重置 TimerMaintenance：定时进入维护模式 TimerHibernate：定时休眠无操作任务： NoOperationShutdown：无操作关机 NoOperationReboot：无操作重启 NoOperationDisconnect：无操作断连 NoOperationHibernate：无操作休眠断连任务： NoConnectShutdown：断连关机 NoConnectHibernate：断连休眠枚举值： NoOperationDisconnect : 无操作断连 NoConnectShutdown : 断连关机 TimerBoot : 定时开机 NoOperationShutdown : 无操作关机 NoOperationHibernate : 无操作休眠 NoConnectHibernate : 断连休眠 TimerShutdown : 定时关机 NoOperationReboot : 无操作重启 TimerReboot : 定时重启	TimerBoot
MaxResults	string	否	分页查询时每页行数。最大值：100。默认值：10。	10
NextToken	string	否	下一个查询开始的 Token。	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
SearchRegionId	string	否	搜索地域 ID。用于过滤出指定地域的云电脑信息。	cn-shanghai
BatchId	string	否	定时类任务执行的批次 ID。	ccg-****
TimerResult	string	否	定时任务的执行结果。枚举值： CONNECTED_NOT_RUN : 云电脑已被连接，定时任务未执行 PAUSED : 执行暂停 COMPLETED : 已完成 FAILED : 执行失败 RUNNING : 运行中 TERMINATED : 执行中止	RUNNING
GroupId	string	否	定时任务组 ID。	ccg-0cvfvf6u1enx1****
ResultCategory	string	否	通过执行结果进行过滤。枚举值： SUCCEED : 执行成功 FAILED : 执行失败 RUNNING : 执行中 SKIPPED : 执行被跳过	SUCCEED
DesktopIds	array	否	云电脑 ID 列表。	SUCCEED
	string	否	云电脑 ID。	ecd-84mztzatmipf2****
Retryable	boolean	否	是否可重试	true
DisplayResultName	string	否	显示结果名称	FAILED
ResourceTypes	array	否	资源类型列表，为空则查询所有资源类型。	true
	string	否	资源类型列表，为空则查询所有资源类型。	Desktop
WuyingServerIds	array	否	无影服务器 ID 列表	FAILED
	string	否	无影服务器 ID 列表中的第一个	ws-xxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	63740E03-1B4B-5A18-AC27-2745A4F2****
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****
Count	integer	总条目数。	2
Results	array<object>	返回结果信息。
	object	结果列表。
BatchId	string	定时类任务执行的批次 ID。	ccg-0cvfvf6u1enx1****
TimerType	string	定时任务类型。	TimerBoot
TimerResult	string	定时任务的执行结果。	RUNNING
CreateTime	string	记录创建时间。时间格式为 ISO 8601 标准的 UTC 时间：yyyy-MM-ddTHH:mm:ssZ。	2023-08-03T08:27:29Z
FinishTime	string	任务结束时间。时间格式为 ISO 8601 标准的 UTC 时间：yyyy-MM-ddTHH:mm:ssZ。	2025-01-21T02:00:45Z
DesktopId	string	云电脑 ID。	ecd-0c951fy9arnk9****
RegionId	string	地域 ID。	cn-hangzhou
DesktopName	string	云电脑名称。	DesktopName
TimerGroupId	string	定时任务组 ID。	ccg-xxxx
ActionType	string	执行的动作类型。	REBOOT
Context	string	定时任务执行过程中的记录信息。	{}
DisplayResultName	string	显示结果名称	SKIPPED
Retryable	boolean	是否可重试	true
TimerRecordId	string	定时记录 ID	t-xxx
ResourceParentId	string	资源父级 ID	p-xxx

示例

正常返回示例

JSON格式

{
  "RequestId": "63740E03-1B4B-5A18-AC27-2745A4F2****",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****",
  "Count": 2,
  "Results": [
    {
      "BatchId": "ccg-0cvfvf6u1enx1****",
      "TimerType": "TimerBoot",
      "TimerResult": "RUNNING",
      "CreateTime": "2023-08-03T08:27:29Z",
      "FinishTime": "2025-01-21T02:00:45Z",
      "DesktopId": "ecd-0c951fy9arnk9****",
      "RegionId": "cn-hangzhou",
      "DesktopName": "DesktopName",
      "TimerGroupId": "ccg-xxxx",
      "ActionType": "REBOOT",
      "Context": "{}",
      "DisplayResultName": "SKIPPED",
      "Retryable": true,
      "TimerRecordId": "t-xxx",
      "ResourceParentId": "p-xxx"
    }
  ]
}

错误码

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

变更历史

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