#UFOP API book
###1. POST /api/ufops(注册一个Ufop)
请求
POST /api/ufops
{
"name": "name",
"aclMode": "aclMode"
"configuration":"configuration"
"desc":"desc"
}结果
{
"code": 200,
}错误
InvalidArgs Code = 400 // 请求参数错误，或者数据未通过验证
ResultError Code = 500 // 请求结果发生错误###2. DELETE /api/ufops/:id(删除一个Ufop)
请求
DELETE /api/ufops/:id结果
{
"code": 200,
}错误
ResultError Code = 500 // 请求结果发生错误
UfopNotfound Code = ?//待定###3. GET /api/ufops/:id(查询一个Ufop的详细信息)
请求
GET /api/ufops/:id结果
{
"code": 200
"data":
{
"name": "ufoptest_v3"
"owner": "1380469902"
"version": "1"
"aclMode": "PRIVATE"
"description": "it is another test!"
"createTime": "1970-01-01 08:00:00 +0800 CST"
"instanceNum": 4"
"maxInstanceNum": "5"
"flavor": "default"
"accessList": "1380469902"
}错误
ResultError Code = 500 // 请求结果发生错误
UfopNotfound Code = ?//待定###4. GET /api/ufops(列出所有的Ufop)
请求
GET /api/ufops结果
{
"code": 200
"data":
[
{
"name": "testzy_123",
"aclMode":"0"
"desc":"这是Ufop的描述"
},
{
"name": "testzy_1234",
"aclMode":"1"
"desc":"这是Ufop的描述"
}
]
}错误
ResultError Code = 500 // 请求结果发生错误###5. POST /api/images(上传一个Ufop Image)
请求
POST /api/images结果
{
"code": 200
}错误
ResultError Code = 500 // 请求结果发生错误###6. GET /api/ufops/:id/versions(获取一个ufop的版本列表)
请求
GET /api/ufops/:id/versions结果
{
"code": 200
"data":
[
{
"version":"v1.1",
"state":"build success",
"createAt":"2015-06-25 17:27:10"
},
{
"version":"v1.2",
"state":"build success",
"createAt":"2015-06-25 17:27:10"
},
{
"version":"v1.3",
"state":"build success",
"createAt":"2015-06-25 17:27:10"
}
]
}错误
UfopNotfound Code = ?//待定
ResultError Code = 500 // 请求结果发生错误###7. GET /api/ufops/:id/instances(获取一个ufop的实例列表)
请求
GET /api/ufops/:id/instances结果
{
"code": 200
"data":
[
{
"index":"1",
"version":"v1.1",
"state":"Stopped"
},
{
"index":"2",
"version":"v1.1",
"state":"Running"
},
{
"index":"3",
"version":"v1.0",
"state":"Running"
}
]
}错误
UfopNotfound Code = ?//待定
ResultError Code = 500 // 请求结果发生错误###8. POST /api/ufops/:id/instances/:id/start(启用一个ufop实例)
请求
POST /api/ufops/:id/instances/:id/start结果
{
"code": 200
"data":
{
"index":"1",
"version":"v1.1",
"state":"Stopped"
}
}错误
UfopNotfound Code = ?//待定
ResultError Code = 500 // 请求结果发生错误###9. POST /api/ufops/:id/instances/:id/stop(停用一个ufop实例)
请求
POST /api/ufops/:id/instances/:id/stop结果
{
"code": 200
"data":
{
"index":"1",
"version":"v1.1",
"state":"Stopped"
}
}错误
UfopNotfound Code = ?//待定
ResultError Code = 500 // 请求结果发生错误###10. POST /api/ufops/:id/instances/:id/reboot(重启某一实例号的ufop实例)
请求
POST /api/ufops/:id/instances/:id/reboot结果
{
"code": 200
"data":
{
"index":"1",
"version":"v1.1",
"state":"Stopped"
}
}错误
ResultError Code = 500 // 请求结果发生错误
UfopNotfound Code = ? // Code待定，Ufop删除失败###11. POST /api/ufops/:id/instances(添加ufop实例)
请求
POST /api/ufops/:id/instances
{
"size":"3"
"version":"v1.0"
}
//得先切换到对应版本才能添加那个版本的实例结果
{
"code": 200
"data":
[
{
"index":"1",
"version":"v1.1",
"state":"Stopped"
},
{
"index":"2",
"version":"v1.1",
"state":"Running"
},
{
"index":"3",
"version":"v1.0",
"state":"Running"
}
]
}错误
InvalidArgs Code = 400 // 请求参数错误，或者数据未通过验证
ResultError Code = 500 // 请求结果发生错误
UfopNotfound Code = ?//待定##12. DELETE /api/ufops/:id/instances/:id(删除某一实例号的ufop实例)
请求
DELETE /api/ufops/:id/instances/:id结果
{
"code": 200
}错误
ResultError Code = 500 // 请求结果发生错误
UfopNotfound Code = ? // Code待定，Ufop删除失败###13. POST /api/ufops/:id/instances/:id/switch(切换到当前ufop实例)
请求
POST /api/ufops/:id/instances/:id/switch结果
{
"code": 200
}错误
ResultError Code = 500 // 请求结果发生错误
UfopNotfound Code = ?//待定###14. GET /api/ufops/:id/instances/:id/log(查看某一个运行的ufop实例的日志)
请求
GET /api/ufops/:id/instances/:id/log结果
{
"code": 200
"data":
{
"log":"2015-07-13 [INFO] start up successfully"
}
}错误
ResultError Code = 500 // 请求结果发生错误
UfopNotfound Code = ?//待定