虚拟机相关接口
创建重启虚拟机的定时任务
Headers
Authorization: OAuth the-session-uuidBody
{
"params": {
"schedulerName": "vm-scheduler",
"schedulerDescription": "for test restart vm scheduler",
"type": "simple",
"interval": 5.0,
"repeatCount": 10.0,
"startTime": 0.0
},
"systemTags": [],
"userTags": []
}上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth fa354b2ef2b34f109f268d264eee4d87" \
-X POST http://localhost:8080/zstack/v1/vm-instances/08eaedbeb14841c5bb8564663319fed9/\
schedulers/rebooting?参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| vmUuid | String | url | 虚拟机uuid | 0.6 | |
| schedulerName | String | body(包含在params结构中) | 定时任务名称 | 1.6 | |
| schedulerDescription (可选) | String | body(包含在params结构中) | 定时任务描述 | 1.6 | |
| type | String | body(包含在params结构中) | 定时任务类型，simple或者cron | simplecron | 1.6 |
| interval (可选) | Integer | body(包含在params结构中) | 定时任务间隔，单位秒 | 1.6 | |
| repeatCount (可选) | Integer | body(包含在params结构中) | 定时任务重复次数，仅针对simple类型的定时任务生效 | 1.6 | |
| startTime (可选) | Long | body(包含在params结构中) | 定时任务启动时间，必须遵循unix timestamp格式，0为从立刻开始 | 1.6 | |
| cron (可选) | String | body(包含在params结构中) | cron表达式，需遵循Java Quartz组件cron格式标准 | 1.6 | |
| resourceUuid (可选) | String | body(包含在params结构中) | 用户可指定创建Scheduler所使用的uuid | 0.6 | |
| systemTags (可选) | List | body | 系统标签 | 0.6 | |
| userTags (可选) | List | body | 用户标签 | 0.6 |
API返回
返回示例
{
"inventory": {
"uuid": "2664ccec6e584e529ab6671d88f87763",
"targetResourceUuid": "308a32f93a7842ce94bdab3220f75aeb",
"schedulerName": "Test",
"schedulerType": "simple",
"repeatCount": 10.0,
"startTime": "May 11, 2017 1:22:27 PM",
"createDate": "May 11, 2017 1:22:27 PM",
"lastOpDate": "May 11, 2017 1:22:27 PM",
"jobClassName": "CreateVolumeSnapshotJob",
"state": "Enabled"
}
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| error | ErrorCode | 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error | 1.6 |
| inventory | SchedulerInventory | 详情参考inventory | 1.6 |
error
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| code | String | 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 | 0.6 |
| description | String | 错误的概要描述 | 0.6 |
| details | String | 错误的详细信息 | 0.6 |
| elaboration | String | 保留字段，默认为null | 0.6 |
| opaque | LinkedHashMap | 保留字段，默认为null | 0.6 |
| cause | ErrorCode | 根错误，引发当前错误的源错误，若无原错误，该字段为null | 0.6 |
inventory
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID，唯一标示该资源 | 0.6 |
| targetResourceUuid | String | 0.6 | |
| schedulerName | String | 0.6 | |
| schedulerJob | String | 0.6 | |
| schedulerType | String | 0.6 | |
| schedulerInterval | Integer | 0.6 | |
| repeatCount | Integer | 0.6 | |
| cronScheduler | String | 0.6 | |
| startTime | Timestamp | 0.6 | |
| stopTime | Timestamp | 0.6 | |
| createDate | Timestamp | 创建时间 | 0.6 |
| lastOpDate | Timestamp | 最后一次修改时间 | 0.6 |
| state | String | 0.6 |
SDK示例
Java SDK
CreateRebootVmInstanceSchedulerAction action = new CreateRebootVmInstanceSchedulerAction();
action.vmUuid = "65f8b54efe254b8e8e5b427bfdadd1e6";
action.schedulerName = "vm-scheduler";
action.schedulerDescription = "for test restart vm scheduler";
action.type = "simple";
action.interval = 5.0;
action.repeatCount = 10.0;
action.startTime = 0.0;
action.sessionId = "3cedf9bd8bbf424f860057259adfcdcf";
CreateRebootVmInstanceSchedulerAction.Result res = action.call();Python SDK
CreateRebootVmInstanceSchedulerAction action = CreateRebootVmInstanceSchedulerAction()
action.vmUuid = "1b0f699afaba45e1865f00bbaf026c6a"
action.schedulerName = "vm-scheduler"
action.schedulerDescription = "for test restart vm scheduler"
action.type = "simple"
action.interval = 5.0
action.repeatCount = 10.0
action.startTime = 0.0
action.sessionId = "22758ee34b2b4822a3253a8a56cee6cf"
CreateRebootVmInstanceSchedulerAction.Result res = action.call()