DescribeTimerGroup - 查询配置组详细信息

更新时间: 2025-03-13 14:29:12

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。该功能无地域属性,该字段固定填写cn-shanghai

cn-shanghai
GroupIdstring

配置组 ID。

cg-hs3i1w39o68ma****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Dataobject

配置组信息。

GroupIdstring

配置组 ID。

cg-75aazkg2tnqb2*****
Namestring

配置组名称。

定时任务
Descriptionstring

配置组描述信息。

定时任务
Typestring

配置组类型。

枚举值:
  • Timer定时任务
Timer
ProductTypestring

配置组使用的产品类型。

枚举值:
  • CLOUD_DESKTOP云电脑
CLOUD_DESKTOP
ConfigTimersarray<object>

定时任务的配置信息,列表结构。

ConfigTimerobject

定时任务的配置信息。

TimerTypestring

定时任务类型。

枚举值:
  • NoOperationDisconnect无操作断连
  • NoConnect断连任务(需指定OperationType)
  • TimerBoot定时开机
  • TimerReset定时重置
  • NoOperationShutdown无操作关机
  • NoOperationHibernate无操作休眠
  • TimerShutdown定时关机
  • NoOperationReboot无操作重启
  • TimerReboot定时重启
TimerBoot
CronExpressionstring

定时任务 Cron 表达式。

0 0 16 ? * 1,2,3,4,5,6,7
Intervalinteger

时间间隔,单位为分钟。

10
Enforceboolean

是否强制执行。为 true 表示忽略桌面及连接状态检测,强制执行定时任务。

false
ResetTypestring

重置定时任务重置类型。

枚举值:
  • RESET_TYPE_SYSTEM重置系统盘
  • RESET_TYPE_USER_DISK重置数据盘
  • RESET_TYPE_BOTH重置系统盘和数据盘
RESET_TYPE_SYSTEM
AllowClientSettingboolean

是否允许终端用户自行配置定时任务。

true
OperationTypestring

断连定时任务类型。

枚举值:
  • Hibernate休眠
  • Shutdown关机
Shutdown
TriggerTypestring

无操作定时任务触发配置类型。

枚举值:
  • Advanced智能判断
  • Standard标准判断
Standard
ProcessWhitelistarray

无操作定时任务智能判断的进程白名单,如果指定的进程正在运行则不支持无操作定时任务。

Processstring

进程名称。

chrome
BindCountinteger

配置组绑定的资源数。

50
Statusstring

配置组状态。

枚举值:
  • AVAILABLE可用
  • UNAVAILABLE已删除
  • DELETING删除中
  • UPDATING修改中
AVAILABLE
BindCountMapobject

配置绑定资源的数量信息。

integer

绑定资源的数量。

10

示例

正常返回示例

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"
        ]
      }
    ],
    "BindCount": 50,
    "Status": "AVAILABLE",
    "BindCountMap": {
      "key": 10
    }
  }
}

错误码

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

上一篇: ModifyTimerGroup - 修改配置组设置 下一篇: MFA
阿里云首页 无影云电脑 相关技术圈