RegisterImage
GET /?Action=RegisterImage
Description
Registers an Outscale machine image (OMI) to finalize its creation process.
You can register an OMI from a snapshot of a root device to create an OMI based on this snapshot. You can also register an OMI that has been exported to an Object Storage Unit (OSU) bucket to create a copy of it in your account. For more information about OMI export to an OSU bucket, see CreateImageExportTask.
You can register an OMI using a pre-signed URL of the manifest file of the OMI. You do not need any permission for this OMI, or the bucket in which it is contained. The manifest file is obsolete seven days after a completed export as it contains pre-signed URLs to the appropriate snapshots (pre-signed URL are valid for only seven days).
Once the OMI is registered, you can launch an instance from this OMI. The copy of the source OMI is independent and belongs to you.
Body parameter
Required: false
Name: RegisterImageRequest
Name | Description | Required | Schema | Default | Example |
---|---|---|---|---|---|
Architecture |
The architecture of the OMI (set to i386 by default). |
false |
string |
||
BlockDeviceMapping.N |
One or more Block Device Mapping entries. |
false |
|||
Description |
A description for the OMI. |
false |
string |
||
ImageLocation |
The pre-signed URL of the OMI manifest file, or the full path to the OMI stored in an OSU bucket. If you specify this parameter, a copy of the OMI is created in your account. |
false |
string |
||
Name |
A unique name for the OMI. |
true |
string |
||
RootDeviceName |
The name of the root device (for example, /dev/sda1) |
false |
string |
Responses
HTTP Code 200
HTTP Code | Description | Schema |
---|---|---|
200 |
RegisterImageResult |
Response 200
Name | Description | Required | Schema | Default | Example |
---|---|---|---|---|---|
imageId |
The ID of the newly registered OMI. |
false |
string |
||
requestId |
The ID of the request. |
false |
string |