BareMetal API, REST: Image.Create

Статья создана

Обновлена 3 октября 2025 г.

HTTP request
Body parameters
Response
CreateImageMetadata
Status
Image

Creates an image in the specified folder.

HTTP request

POST https://baremetal.api.yandexcloud.kz/baremetal/v1alpha/images

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "uri": "string",
  "labels": "object"
}

Field	Description
folderId	string ID of the folder to create an image in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.
name	string Name of the image. The name must be unique within the folder.
description	string Description of the image.
uri	string Required field. URI of the source image to create the new image from. Currently only supports links to images that are stored in Object Storage. Currently only supports ISO formats.
labels	object (map<string, string>) Resource labels as `key:value` pairs.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "imageId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "name": "string",
    "description": "string",
    "checksum": "string",
    "status": "string",
    "createdAt": "string",
    "labels": "object"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	CreateImageMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Image The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

CreateImageMetadata

Field

Description

imageId

string

ID of the image that is being created.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Image

An Image resource.

Field	Description
id	string ID of the image.
folderId	string ID of the folder that the image belongs to.
name	string Name of the image. The name is unique within the folder.
description	string Description of the image.
checksum	string MD5 checksum of the image.
status	enum (Status) Status of the image. `STATUS_UNSPECIFIED`: Unspecified image status. `CREATING`: Image is being created. `READY`: Image is ready to use. `ERROR`: Image encountered an error. `DELETING`: Image is being deleted. `UPDATING`: Image is being updated.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
labels	object (map<string, string>) Resource labels as `key:value` pairs.

BareMetal API, REST: Image.Create

HTTP requestHTTP request

Body parametersBody parameters

ResponseResponse

CreateImageMetadataCreateImageMetadata

StatusStatus

ImageImage