dsdk / v1.47 / ImageCreateData
Type Alias: ImageCreateData ​
ImageCreateData:
object
Type declaration ​
| Name | Type | Description |
|---|---|---|
body? | object | - |
body.inputImage? | Buffer | string | Image content if the value - has been specified in fromSrc query parameter |
headers? | object | - |
headers.X-Registry-Auth? | string | A base64url-encoded auth configuration. Refer to the authentication section for details. |
query? | object | - |
query.changes? | string[] | Apply Dockerfile instructions to the image that is created, for example: changes=ENV DEBUG=true. Note that ENV DEBUG=true should be URI component encoded. Supported Dockerfile instructions: CMD |
query.fromImage? | string | Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed. |
query.fromSrc? | string | Source to import. The value may be a URL from which the image can be retrieved or - to read the image from the request body. This parameter may only be used when importing an image. |
query.message? | string | Set commit message for imported image. |
query.platform? | string | Platform in the format os[/arch[/variant]]. When used in combination with the fromImage option, the daemon checks if the given image is present in the local image cache with the given OS and Architecture, and otherwise attempts to pull the image. If the option is not set, the host's native OS and Architecture are used. If the given image does not exist in the local image cache, the daemon attempts to pull the image with the host's native OS and Architecture. If the given image does exists in the local image cache, but its OS or architecture does not match, a warning is produced. When used with the fromSrc option to import an image from an archive, this option sets the platform information for the imported image. If the option is not set, the host's native OS and Architecture are used for the imported image. |
query.repo? | string | Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image. |
query.tag? | string | Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. |