Difference between revisions of "Nova-scheduled-images-extension"
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | = Nova Scheduled Images API Extension = | |
| − | ==== Enable scheduled images | + | == Summary == |
| + | ; Name : Scheduled Images Extension | ||
| + | ; Namespace : http://docs.openstack.org/servers/api/ext/schedimg/v1.0 | ||
| + | ; Alias : OS-SI | ||
| + | ; Dependencies : [[OpenStack]] Compute API v1.1 | ||
| + | ; Short Description : Enables automatic daily images to be taken of a server. | ||
| + | ; New Headers : None. | ||
| + | ; New Faults : None. | ||
| + | ; New Actions : None. | ||
| + | ; New Resources : Detailed below. | ||
| + | |||
| + | <<[[TableOfContents]]()>> | ||
| + | |||
| + | == New Resources == | ||
| + | === Enable scheduled images === | ||
<pre><nowiki> | <pre><nowiki> | ||
| − | POST /{tenantId}/servers/{serverId}/scheduled_images | + | POST /{tenantId}/servers/{serverId}/OS-SI/scheduled_images |
</nowiki></pre> | </nowiki></pre> | ||
| Line 21: | Line 35: | ||
If a retention value has already been specified for an instance, it is overridden. | If a retention value has already been specified for an instance, it is overridden. | ||
| − | + | === Disable scheduled images === | |
<pre><nowiki> | <pre><nowiki> | ||
| − | DELETE /{tenantId}/servers/{serverId}/scheduled_images | + | DELETE /{tenantId}/servers/{serverId}/OS-SI/scheduled_images |
</nowiki></pre> | </nowiki></pre> | ||
No response body. | No response body. | ||
| − | + | === Show scheduled images setting === | |
<pre><nowiki> | <pre><nowiki> | ||
| − | GET /{tenantId}/servers/{serverId}/scheduled_images | + | GET /{tenantId}/servers/{serverId}/OS-SI/scheduled_images |
</nowiki></pre> | </nowiki></pre> | ||
| Line 47: | Line 61: | ||
| − | + | === List all instances with scheduled images enabled === | |
<pre><nowiki> | <pre><nowiki> | ||
| − | GET /{tenantId}/servers/scheduled_images | + | GET /{tenantId}/servers/OS-SI/scheduled_images |
</nowiki></pre> | </nowiki></pre> | ||
Revision as of 21:08, 11 January 2013
Nova Scheduled Images API Extension
Summary
- Name
- Scheduled Images Extension
- Namespace
- http://docs.openstack.org/servers/api/ext/schedimg/v1.0
- Alias
- OS-SI
- Dependencies
- OpenStack Compute API v1.1
- Short Description
- Enables automatic daily images to be taken of a server.
- New Headers
- None.
- New Faults
- None.
- New Actions
- None.
- New Resources
- Detailed below.
<<TableOfContents()>>
New Resources
Enable scheduled images
POST /{tenantId}/servers/{serverId}/OS-SI/scheduled_images
Request body:
{
"scheduled_image" : {
"retention": INT
}
}
Retention: Specifies the number of snapshots created by the scheduled images service to keep for an instance. If a retention value has already been specified for an instance, it is overridden.
Disable scheduled images
DELETE /{tenantId}/servers/{serverId}/OS-SI/scheduled_images
No response body.
Show scheduled images setting
GET /{tenantId}/servers/{serverId}/OS-SI/scheduled_images
(If the scheduled images feature is not enabled for this instance, the API will return a 404.)
Response Body:
{
"serverId": <UUID>,
"retention": INT,
}
List all instances with scheduled images enabled
GET /{tenantId}/servers/OS-SI/scheduled_images
Response Body:
{
"scheduledImages" : [
{
"instance": <UUID>,
"retention": INT,
}
]
}
