文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 定时任务/ 查询生命周期类型配置 - ListLifeCycleTypeConfigurations
更新时间：2026-05-21 GMT+08:00
查看PDF
分享

查询生命周期类型配置 - ListLifeCycleTypeConfigurations

功能介绍

根据type查询Apollo配置项life.cycle.type.action，获取对应的配置信息。不传type时返回所有配置项。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:scheduledTasks:listLifeCycleConfigurations

    List

    -

    -

    -

    -

URI

GET /v2/{project_id}/scheduled-tasks/life-cycle-type/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

type

否

String

触发场景类型。POST_CREATE_DESKTOP_SUCCESS：创建桌面成功后，POST_REBUILD_DESKTOP_SUCCESS：重建桌面成功后，POST_REATTACH_DESKTOP_SUCCESS：触发重建的分配用户任务成功后，POST_DESKTOP_DISCONNECTED：桌面断开连接后，POST_DESKTOP_CANNOT_CONNECT：桌面无法连接。不传时返回所有配置项。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

{自定义key}

Map<String,LifeCycleTypeConfigRsp>

生命周期类型配置响应。
表4 LifeCycleTypeConfigRsp

参数

参数类型

描述

min_wait_time

Integer

最小等待时长，单位分钟。

default_wait_time

Integer

默认等待时长，单位分钟。

min_exec_time

Integer

最小执行周期，单位分钟。

default_exec_time

Integer

默认执行周期，单位分钟。

support_exec_time

Boolean

是否支持执行周期。

actions

Array of ActionConfig objects

可执行的动作列表。
表5 ActionConfig

参数

参数类型

描述

action

String

动作名称。STOP：关机，HIBERNATE：休眠，REBOOT：重启，EXECUTE_SCRIPT：执行脚本。

min_wait_time

Integer

最小等待时长，单位分钟。如果不填，则使用父级的 min_wait_time。

default_wait_time

Integer

默认等待时长，单位分钟。如果不填，则使用父级的 default_wait_time。

min_exec_time

Integer

最小执行周期，单位分钟。如果不填，则使用父级的 min_exec_time。

default_exec_time

Integer

默认执行周期，单位分钟。如果不填，则使用父级的 default_exec_time。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

无

响应示例

状态码：200

正常。

{
  "POST_CREATE_DESKTOP_SUCCESS" : {
    "min_wait_time" : 0,
    "default_wait_time" : 0,
    "min_exec_time" : 0,
    "default_exec_time" : 0,
    "actions" : [ {
      "action" : "STOP"
    }, {
      "action" : "HIBERNATE"
    }, {
      "action" : "REBOOT"
    }, {
      "action" : "EXECUTE_SCRIPT"
    } ]
  },
  "POST_DESKTOP_CANNOT_CONNECT" : {
    "min_wait_time" : 0,
    "default_wait_time" : 10,
    "min_exec_time" : 0,
    "default_exec_time" : 1440,
    "actions" : [ {
      "action" : "STOP"
    }, {
      "action" : "HIBERNATE"
    }, {
      "action" : "REBOOT",
      "min_wait_time" : 3,
      "default_wait_time" : 10,
      "min_exec_time" : 60,
      "default_exec_time" : 1440
    }, {
      "action" : "EXECUTE_SCRIPT"
    } ]
  }
}

状态码

状态码

描述

200

正常。

400

由于包含语法错误，当前请求无法被服务器理解。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 定时任务