查询计划事件列表 - ListScheduledEvents
功能介绍
查询服务器计划事件列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cph:scheduledEvents:list
List
-
-
-
-
URI
GET /v1/{project_id}/cloud-phone/scheduled-events
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目id。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 每页返回的事件个数。取值范围:1~100(默认值为10) |
| marker | 否 | String | 分页标记。从marker指定的下一条数据开始查询。 |
| event_id | 否 | String | 计划事件id。 |
| server_id | 否 | String | 云手机服务器的唯一标识。 |
| publish_since | 否 | String | 事件发布开始时间,按照时间范围过滤。 |
| publish_until | 否 | String | 事件发布结束时间,按照时间范围过滤。 |
| state | 否 | Array of strings | 计划事件状态。支持多值查询过滤。 取值范围: inquiring: 待授权、 scheduled:待执行、 executing:执行中、 completed:执行成功、 failed:执行失败、 canceled:取消 |
| type | 否 | Array of strings | 计划事件类型。支持多值查询过滤。取值范围: localdisk-recovery:本地盘换盘、 system-maintenance:系统维护 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 请求的唯一标识ID。 |
| count | Integer | 计划事件总数。 |
| scheduled_events | Array of scheduled_events objects | 计划事件信息 |
| page_info | page_info object | 页标记。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| event_id | String | 计划事件唯一标识,不超过36个字节 |
| server_id | String | 云手机服务器的唯一标识,不超过32个字节。 |
| server_name | String | 云手机服务器名称, 不超过65字符,只支持英文字母、数字、汉字、下划线和中划线。 |
| server_model_name | String | 云手机服务器规格名称,不超过64个字节。 |
| server_state | Integer | 服务器状态。 |
| type | String | 计划事件类型,取值范围: localdisk-recovery:本地盘换盘、 system-maintenance:系统维护 |
| authorization_type | String | 授权类型,取值范围:maintenance:授权维修、redeploy:授权重部署 |
| state | String | 计划事件状态, 取值范围: inquiring: 待授权、 scheduled:待执行、 executing:执行中、 completed:执行成功、 failed:执行失败、 canceled:取消 |
| publish_time | String | 事件发布时间 |
| start_time | String | 事件开始时间 |
| finish_time | String | 事件完成时间 |
| not_before | String | 计划执行开始时间 |
| not_after | String | 计划执行完成时间 |
| not_before_deadline | String | 计划执行开始时间deadline |
| description | String | 计划事件描述 |
请求示例
查询计划事件列表
GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/scheduled-events 响应示例
状态码:200
ok
{
"page_info" : {
"next_marker" : "MTEzMzA2MTgtOWI3Mi00OTkxLWIxYWEtNDJjNmQyZDZiZWFjIzE3ODA4MDE1NjMwMDA"
},
"request_id" : "039061fe179d479d4b13ca668ed6b75b",
"scheduled_events" : [ {
"event_id" : "a7cc9295-b102-4673-a8fe-6374ac9aca4c",
"type" : "localdisk-recovery",
"authorization_type" : null,
"state" : "inquiring",
"publish_time" : "2026-06-07T08:01:18Z",
"start_time" : null,
"finish_time" : null,
"not_before" : null,
"not_after" : null,
"not_before_deadline" : "2026-07-07T08:01:18Z",
"description" : "{\"en-us\":\"Local disks are faulty\",\"zh-cn\":\"本地盘故障\"}",
"server_id" : "3b814471f9c448ba8b0e44fff6a33222",
"server_name" : "cph-rx1自动化测试-ql勿删-1",
"server_model_name" : "physical.rx1.xlarge",
"server_state" : 5
}, {
"event_id" : "11330618-9b72-4991-b1aa-42c6d2d6beac",
"type" : "system-maintenance",
"authorization_type" : "redeploy",
"state" : "failed",
"publish_time" : "2026-06-07T03:06:03Z",
"start_time" : "2026-06-07T03:09:03Z",
"finish_time" : "2026-06-07T03:41:00Z",
"not_before" : "2026-06-07T03:08:12Z",
"not_after" : null,
"not_before_deadline" : "2026-07-07T03:06:03Z",
"description" : "{\"en-us\":\"As being affected by underlying hardware or system OM, ECSs will be repaired\",\"zh-cn\":\"由于底层硬件、系统运维等影响,实例在计划时间维修\"}",
"server_id" : "a6dac71bff444df480050ac9f4d8ac3d",
"server_name" : "cph-ql-变更服务器测试-勿动-1-1",
"server_model_name" : "physical.rx2.32xlarge.4.dedicated",
"server_state" : 2
} ],
"count" : 2
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | ok |
错误码
请参见错误码。