Request
- Request parameters -
- Example request
DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags/aaaa-
Request
Request parameters
+None
+Example Request
Deleting an image tag
+DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags/aaaa
Returned Values
- Normal
- Abnormal
-
Returned Value
+Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
Request error.
+Request error.
401 Unauthorized
+401 Unauthorized
Authentication failed.
+Authentication failed.
403 Forbidden
+403 Forbidden
You do not have the rights to perform the operation.
+You do not have the rights to perform the operation.
404 Not Found
+404 Not Found
The requested resource was not found.
+The requested resource was not found.
500 Internal Server Error
+500 Internal Server Error
Internal service error.
+Internal service error.
503 Service Unavailable
+503 Service Unavailable
The service is unavailable.
+The service is unavailable.
- Querying an Image List Schema (Native OpenStack API)
-
- Querying an Image Member Schema (Native OpenStack API)
+- Querying a Schema for an Image Sharing Member (Native OpenStack API)
-
- Querying an Image Member List Schema (Native OpenStack API)
+- Querying a Schema for an Image Sharing Member List (Native OpenStack API)
diff --git a/docs/ims/api-ref/en-us_topic_0020091555.html b/docs/ims/api-ref/en-us_topic_0020091555.html index 44bbfeaae..0dd2872bf 100644 --- a/docs/ims/api-ref/en-us_topic_0020091555.html +++ b/docs/ims/api-ref/en-us_topic_0020091555.html @@ -5,47 +5,49 @@
-URI
GET /v2/schemas/image
Request
++Request
Request parameters
+None
+Example Request
Querying an image schema
+GET https://{Endpoint}/v2/schemas/imageResponse
- Response parameters
-
Parameter
+-Parameter
Type
+Type
Description
+Description
additionalProperties
+additionalProperties
Object
+Object
Specifies the additional attributes.
+Specifies the additional attributes.
For details, see Table 1.
name
+name
String
+String
Specifies the schema name.
+Specifies the schema name.
links
+links
Array of objects
+Array of objects
Specifies the URL for accessing the schema.
+Specifies the URL for accessing the schema.
For details, see Table 2.
properties
+properties
Object
+Object
Describes basic image attributes, including the type and usage of each attribute.
+Describes basic image attributes, including the type and usage of each attribute.
For details about the parameters, see Image Attributes.
Table 1 Data structure description of the additionalProperties field Parameter
+-Table 1 Data structure description of the additionalProperties field Parameter
Type
+Type
Description
+Description
type
+type
String
+String
Type
+Type
Table 2 Data structure description of the links field Parameter
+Table 2 Data structure description of the links field Parameter
Type
+Type
Description
+Description
href
+href
String
+String
Specifies the domain name.
+Specifies the domain name.
rel
+rel
String
+String
Specifies the domain name description.
+Specifies the domain name description.
- Example response
STATUS CODE 200
-1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 - 83 - 84 - 85 - 86 - 87 - 88 - 89 - 90 - 91 - 92 - 93 - 94 - 95 - 96 - 97 - 98 - 99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193
+ +{ - "additionalProperties": { - "type": "string" - }, - "name": "image", - "links": [ - { - "href": "{self}", - "rel": "self" - }, - { - "href": "{file}", - "rel": "enclosure" - }, - { - "href": "{schema}", - "rel": "describedby" - } - ], - "properties": { - "status": { - "enum": [ - "queued", - "saving", - "active", - "killed", - "deleted", - "pending_delete" - ], - "type": "string", - "description": "Status of the image (READ-ONLY)" - }, - "tags": { - "items": { - "type": "string", - "maxLength": 255 - }, - "type": "array", - "description": "List of strings related to the image" - }, - "kernel_id": { - "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", - "type": "string", - "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.", - "is_base": false - }, - "container_format": { - "enum": [ - "ami", - "ari", - "aki", - "bare", - "ovf", - "ova" - ], - "type": "string", - "description": "Format of the container" - }, - "min_ram": { - "type": "integer", - "description": "Amount of ram (in MB) required to boot image." - }, - "ramdisk_id": { - "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", - "type": "string", - "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.", - "is_base": false - }, - "locations": { - "items": { - "required": [ - "url", - "metadata" - ], - "type": "object", - "properties": { - "url": { - "type": "string", - "maxLength": 255 - }, - "metadata": { - "type": "object" - } - } - }, - "type": "array", - "description": "A set of URLs to access the image file kept in external store" - }, - "visibility": { - "enum": [ - "public", - "private" - ], - "type": "string", - "description": "Scope of image accessibility" - }, - "updated_at": { - "type": "string", - "description": "Date and time of the last image modification (READ-ONLY)" - }, - "owner": { - "type": "string", - "description": "Owner of the image", - "maxLength": 255 - }, - "file": { - "type": "string", - "description": "(READ-ONLY)" - }, - "min_disk": { - "type": "integer", - "description": "Amount of disk space (in GB) required to boot image." - }, - "virtual_size": { - "type": "integer", - "description": "Virtual size of image in bytes (READ-ONLY)" - }, - "id": { - "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", - "type": "string", - "description": "An identifier for the image" - }, - "size": { - "type": "integer", - "description": "Size of image file in bytes (READ-ONLY)" - }, - "instance_uuid": { - "type": "string", - "description": "ID of instance used to create this image.", - "is_base": false - }, - "os_distro": { - "type": "string", - "description": "Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html", - "is_base": false - }, - "name": { - "type": "string", - "description": "Descriptive name for the image", - "maxLength": 255 - }, - "checksum": { - "type": "string", - "description": "md5 hash of image contents. (READ-ONLY)", - "maxLength": 32 - }, - "created_at": { - "type": "string", - "description": "Date and time of image registration (READ-ONLY)" - }, - "disk_format": { - "enum": [ - "ami", - "ari", - "aki", - "vhd", - "vmdk", - "raw", - "qcow2", - "vdi", - "iso" - ], - "type": "string", - "description": "Format of the disk" - }, - "os_version": { - "type": "string", - "description": "Operating system version as specified by the distributor", - "is_base": false - }, - "protected": { - "type": "boolean", - "description": "If true, image will not be deletable." - }, - "architecture": { - "type": "string", - "description": "Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html", - "is_base": false - }, - "direct_url": { - "type": "string", - "description": "URL to access the image file kept in external store (READ-ONLY)" - }, - "self": { - "type": "string", - "description": "(READ-ONLY)" - }, - "schema": { - "type": "string", - "description": "(READ-ONLY)" - } - } +
- -1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193
{ + "additionalProperties": { + "type": "string" + }, + "name": "image", + "links": [ + { + "href": "{self}", + "rel": "self" + }, + { + "href": "{file}", + "rel": "enclosure" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], + "properties": { + "status": { + "enum": [ + "queued", + "saving", + "active", + "killed", + "deleted", + "pending_delete" + ], + "type": "string", + "description": "Status of the image (READ-ONLY)" + }, + "tags": { + "items": { + "type": "string", + "maxLength": 255 + }, + "type": "array", + "description": "List of strings related to the image" + }, + "kernel_id": { + "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", + "type": "string", + "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.", + "is_base": false + }, + "container_format": { + "enum": [ + "ami", + "ari", + "aki", + "bare", + "ovf", + "ova" + ], + "type": "string", + "description": "Format of the container" + }, + "min_ram": { + "type": "integer", + "description": "Amount of ram (in MB) required to boot image." + }, + "ramdisk_id": { + "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", + "type": "string", + "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.", + "is_base": false + }, + "locations": { + "items": { + "required": [ + "url", + "metadata" + ], + "type": "object", + "properties": { + "url": { + "type": "string", + "maxLength": 255 + }, + "metadata": { + "type": "object" + } + } + }, + "type": "array", + "description": "A set of URLs to access the image file kept in external store" + }, + "visibility": { + "enum": [ + "public", + "private" + ], + "type": "string", + "description": "Scope of image accessibility" + }, + "updated_at": { + "type": "string", + "description": "Date and time of the last image modification (READ-ONLY)" + }, + "owner": { + "type": "string", + "description": "Owner of the image", + "maxLength": 255 + }, + "file": { + "type": "string", + "description": "(READ-ONLY)" + }, + "min_disk": { + "type": "integer", + "description": "Amount of disk space (in GB) required to boot image." + }, + "virtual_size": { + "type": "integer", + "description": "Virtual size of image in bytes (READ-ONLY)" + }, + "id": { + "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", + "type": "string", + "description": "An identifier for the image" + }, + "size": { + "type": "integer", + "description": "Size of image file in bytes (READ-ONLY)" + }, + "instance_uuid": { + "type": "string", + "description": "ID of instance used to create this image.", + "is_base": false + }, + "os_distro": { + "type": "string", + "description": "Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html", + "is_base": false + }, + "name": { + "type": "string", + "description": "Descriptive name for the image", + "maxLength": 255 + }, + "checksum": { + "type": "string", + "description": "md5 hash of image contents. (READ-ONLY)", + "maxLength": 32 + }, + "created_at": { + "type": "string", + "description": "Date and time of image registration (READ-ONLY)" + }, + "disk_format": { + "enum": [ + "ami", + "ari", + "aki", + "vhd", + "vmdk", + "raw", + "qcow2", + "vdi", + "iso" + ], + "type": "string", + "description": "Format of the disk" + }, + "os_version": { + "type": "string", + "description": "Operating system version as specified by the distributor", + "is_base": false + }, + "protected": { + "type": "boolean", + "description": "If true, image will not be deletable." + }, + "architecture": { + "type": "string", + "description": "Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html", + "is_base": false + }, + "direct_url": { + "type": "string", + "description": "URL to access the image file kept in external store (READ-ONLY)" + }, + "self": { + "type": "string", + "description": "(READ-ONLY)" + }, + "schema": { + "type": "string", + "description": "(READ-ONLY)" + } + } } -
Returned Values
- Normal
- Abnormal
-
Returned Value
+Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
Request error.
+Request error.
401 Unauthorized
+401 Unauthorized
Authentication failed.
+Authentication failed.
403 Forbidden
+403 Forbidden
You do not have the rights to perform the operation.
+You do not have the rights to perform the operation.
404 Not Found
+404 Not Found
The requested resource was not found.
+The requested resource was not found.
500 Internal Server Error
+500 Internal Server Error
Internal service error.
+Internal service error.
503 Service Unavailable
+503 Service Unavailable
The service is unavailable.
+The service is unavailable.
-URI
GET /v2/schemas/images
Request
++Request
Request parameters
+None
+Example Request
Querying an image list schema
+GET https://{Endpoint}/v2/schemas/imagesResponse
- Response parameters
-
Parameter
+-Parameter
Type
+Type
Description
+Description
name
+name
String
+String
Specifies the schema name.
+Specifies the schema name.
links
+links
Array of objects
+Array of objects
Specifies the URL for accessing the schema.
+Specifies the URL for accessing the schema.
For details, see Table 1.
properties
+properties
Object
+Object
Describes basic image attributes, including the type and usage of each attribute.
+Describes basic image attributes, including the type and usage of each attribute.
For details about the parameters, see Image Attributes.
Table 1 Data structure description of the links field Parameter
+Table 1 Data structure description of the links field Parameter
Type
+Type
Description
+Description
href
+href
String
+String
Specifies the domain name.
+Specifies the domain name.
rel
+rel
String
+String
Specifies the domain name description.
+Specifies the domain name description.
- Example response
STATUS CODE 200
-1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 - 83 - 84 - 85 - 86 - 87 - 88 - 89 - 90 - 91 - 92 - 93 - 94 - 95 - 96 - 97 - 98 - 99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224
+ +{ - "name": "images", - "links": [ - { - "href": "{first}", - "rel": "first" - }, - { - "href": "{next}", - "rel": "next" - }, - { - "href": "{schema}", - "rel": "describedby" - } - ], - "properties": { - "images": { - "items": { - "additionalProperties": { - "type": "String" - }, - "name": "image", - "links": [ - { - "href": "{self}", - "rel": "self" - }, - { - "href": "{file}", - "rel": "enclosure" - }, - { - "href": "{schema}", - "rel": "describedby" - } - ], - "properties": { - "status": { - "enum": [ - "queued", - "saving", - "active", - "killed", - "deleted", - "pending_delete" - ], - "type": "string", - "description": "Status of the image (READ-ONLY)" - }, - "tags": { - "items": { - "type": "string", - "maxLength": 255 - }, - "type": "array", - "description": "List of strings related to the image" - }, - "kernel_id": { - "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", - "type": "string", - "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.", - "is_base": false - }, - "container_format": { - "enum": [ - "ami", - "ari", - "aki", - "bare", - "ovf", - "ova" - ], - "type": "string", - "description": "Format of the container" - }, - "min_ram": { - "type": "integer", - "description": "Amount of ram (in MB) required to boot image." - }, - "ramdisk_id": { - "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", - "type": "string", - "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.", - "is_base": false - }, - "locations": { - "items": { - "required": [ - "url", - "metadata" - ], - "type": "object", - "properties": { - "url": { - "type": "string", - "maxLength": 255 - }, - "metadata": { - "type": "object" - } - } - }, - "type": "array", - "description": "A set of URLs to access the image file kept in external store" - }, - "visibility": { - "enum": [ - "public", - "private" - ], - "type": "string", - "description": "Scope of image accessibility" - }, - "updated_at": { - "type": "string", - "description": "Date and time of the last image modification (READ-ONLY)" - }, - "owner": { - "type": "string", - "description": "Owner of the image", - "maxLength": 255 - }, - "file": { - "type": "string", - "description": "(READ-ONLY)" - }, - "min_disk": { - "type": "integer", - "description": "Amount of disk space (in GB) required to boot image." - }, - "virtual_size": { - "type": "integer", - "description": "Virtual size of image in bytes (READ-ONLY)" - }, - "id": { - "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", - "type": "string", - "description": "An identifier for the image" - }, - "size": { - "type": "integer", - "description": "Size of image file in bytes (READ-ONLY)" - }, - "instance_uuid": { - "type": "string", - "description": "ID of instance used to create this image.", - "is_base": false - }, - "os_distro": { - "type": "string", - "description": "Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html", - "is_base": false - }, - "name": { - "type": "string", - "description": "Descriptive name for the image", - "maxLength": 255 - }, - "checksum": { - "type": "string", - "description": "md5 hash of image contents. (READ-ONLY)", - "maxLength": 32 - }, - "created_at": { - "type": "string", - "description": "Date and time of image registration (READ-ONLY)" - }, - "disk_format": { - "enum": [ - "ami", - "ari", - "aki", - "vhd", - "vmdk", - "raw", - "qcow2", - "vdi", - "iso" - ], - "type": "string", - "description": "Format of the disk" - }, - "os_version": { - "type": "string", - "description": "Operating system version as specified by the distributor", - "is_base": false - }, - "protected": { - "type": "boolean", - "description": "If true, image will not be deletable." - }, - "architecture": { - "type": "string", - "description": "Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html", - "is_base": false - }, - "direct_url": { - "type": "string", - "description": "URL to access the image file kept in external store (READ-ONLY)" - }, - "self": { - "type": "string", - "description": "(READ-ONLY)" - }, - "schema": { - "type": "string", - "description": "(READ-ONLY)" - } - } - }, - "type": "array" - }, - "schema": { - "type": "string" - }, - "next": { - "type": "string" - }, - "first": { - "type": "string" - } - } +
- -1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224
{ + "name": "images", + "links": [ + { + "href": "{first}", + "rel": "first" + }, + { + "href": "{next}", + "rel": "next" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], + "properties": { + "images": { + "items": { + "additionalProperties": { + "type": "String" + }, + "name": "image", + "links": [ + { + "href": "{self}", + "rel": "self" + }, + { + "href": "{file}", + "rel": "enclosure" + }, + { + "href": "{schema}", + "rel": "describedby" + } + ], + "properties": { + "status": { + "enum": [ + "queued", + "saving", + "active", + "killed", + "deleted", + "pending_delete" + ], + "type": "string", + "description": "Status of the image (READ-ONLY)" + }, + "tags": { + "items": { + "type": "string", + "maxLength": 255 + }, + "type": "array", + "description": "List of strings related to the image" + }, + "kernel_id": { + "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", + "type": "string", + "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.", + "is_base": false + }, + "container_format": { + "enum": [ + "ami", + "ari", + "aki", + "bare", + "ovf", + "ova" + ], + "type": "string", + "description": "Format of the container" + }, + "min_ram": { + "type": "integer", + "description": "Amount of ram (in MB) required to boot image." + }, + "ramdisk_id": { + "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", + "type": "string", + "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.", + "is_base": false + }, + "locations": { + "items": { + "required": [ + "url", + "metadata" + ], + "type": "object", + "properties": { + "url": { + "type": "string", + "maxLength": 255 + }, + "metadata": { + "type": "object" + } + } + }, + "type": "array", + "description": "A set of URLs to access the image file kept in external store" + }, + "visibility": { + "enum": [ + "public", + "private" + ], + "type": "string", + "description": "Scope of image accessibility" + }, + "updated_at": { + "type": "string", + "description": "Date and time of the last image modification (READ-ONLY)" + }, + "owner": { + "type": "string", + "description": "Owner of the image", + "maxLength": 255 + }, + "file": { + "type": "string", + "description": "(READ-ONLY)" + }, + "min_disk": { + "type": "integer", + "description": "Amount of disk space (in GB) required to boot image." + }, + "virtual_size": { + "type": "integer", + "description": "Virtual size of image in bytes (READ-ONLY)" + }, + "id": { + "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$", + "type": "string", + "description": "An identifier for the image" + }, + "size": { + "type": "integer", + "description": "Size of image file in bytes (READ-ONLY)" + }, + "instance_uuid": { + "type": "string", + "description": "ID of instance used to create this image.", + "is_base": false + }, + "os_distro": { + "type": "string", + "description": "Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html", + "is_base": false + }, + "name": { + "type": "string", + "description": "Descriptive name for the image", + "maxLength": 255 + }, + "checksum": { + "type": "string", + "description": "md5 hash of image contents. (READ-ONLY)", + "maxLength": 32 + }, + "created_at": { + "type": "string", + "description": "Date and time of image registration (READ-ONLY)" + }, + "disk_format": { + "enum": [ + "ami", + "ari", + "aki", + "vhd", + "vmdk", + "raw", + "qcow2", + "vdi", + "iso" + ], + "type": "string", + "description": "Format of the disk" + }, + "os_version": { + "type": "string", + "description": "Operating system version as specified by the distributor", + "is_base": false + }, + "protected": { + "type": "boolean", + "description": "If true, image will not be deletable." + }, + "architecture": { + "type": "string", + "description": "Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html", + "is_base": false + }, + "direct_url": { + "type": "string", + "description": "URL to access the image file kept in external store (READ-ONLY)" + }, + "self": { + "type": "string", + "description": "(READ-ONLY)" + }, + "schema": { + "type": "string", + "description": "(READ-ONLY)" + } + } + }, + "type": "array" + }, + "schema": { + "type": "string" + }, + "next": { + "type": "string" + }, + "first": { + "type": "string" + } + } } -
Returned Values
- Normal
- Abnormal
-
Returned Value
+Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
Request error.
+Request error.
401 Unauthorized
+401 Unauthorized
Authentication failed.
+Authentication failed.
403 Forbidden
+403 Forbidden
You do not have the rights to perform the operation.
+You do not have the rights to perform the operation.
404 Not Found
+404 Not Found
The requested resource was not found.
+The requested resource was not found.
500 Internal Server Error
+500 Internal Server Error
Internal service error.
+Internal service error.
503 Service Unavailable
+503 Service Unavailable
The service is unavailable.
+The service is unavailable.
Image Attributes
-Description
An image is an ECS template containing mandatory software, such as an OS. The template may also contain application software, such as database software, and proprietary software. Image is the core object of IMS.
+Description
An image is a template containing mandatory software, such as an OS. The template may also contain application software, such as database software, and proprietary software. Image is the core object of IMS.
-Image Attributes
Name
@@ -290,21 +290,21 @@String
Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
__support_diskintensive
String
Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
__support_highperformance
String
Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
__support_xen_gpu_type
@@ -327,15 +327,15 @@String
Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+This attribute cannot co-exist with __support_xen.
__support_kvm_infiniband
String
Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen.
__is_config_init
diff --git a/docs/ims/api-ref/en-us_topic_0020091565.html b/docs/ims/api-ref/en-us_topic_0020091565.html index d4f7aa29e..02b6e2a6e 100644 --- a/docs/ims/api-ref/en-us_topic_0020091565.html +++ b/docs/ims/api-ref/en-us_topic_0020091565.html @@ -145,7 +145,7 @@Integer
Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.
+Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.
__os_bit
@@ -163,7 +163,7 @@String
Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
+Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, CoreOS, EulerOS, or Other.
marker
@@ -181,7 +181,7 @@Integer
Specifies the number of images to be queried. The value is an integer and is 500 by default.
+Specifies the number of images that will be returned. The value is an integer and is 500 by default.
sort_key
@@ -256,7 +256,7 @@String
Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
For the supported OSs, see Table 4.
String
Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
__support_highperformance
@@ -276,7 +276,7 @@String
Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
__support_xen_gpu_type
@@ -294,7 +294,7 @@String
Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
__support_xen_hana
@@ -304,7 +304,7 @@String
Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen and __support_kvm.
+This attribute cannot co-exist with __support_xen and __support_kvm.
__support_kvm_infiniband
@@ -313,8 +313,8 @@String
Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen.
virtual_env_type
@@ -358,7 +358,7 @@String
Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.
+Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.
The following operators are supported:
- gt: greater than
- gte: greater than or equal to
- lt: less than
- lte: less than or equal to
- eq: equal to
- neq: not equal to
The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.
@@ -370,9 +370,11 @@Request
- Request parameters -
- Example request
GET https://{Endpoint}/v2/cloudimages?__imagetype=gold&sort_key=name&limit=1-
+Request
Request parameters
+None
+Example Request
Querying public images (the results will be sorted by image name and only one image will be returned)
+GET https://{Endpoint}/v2/cloudimages?__imagetype=gold&sort_key=name&limit=1Common Query Methods
Response
- Response parameters
-
Parameter
+-Parameter
Type
+Type
Description
+Description
images
+images
Array of objects
+Array of objects
Specifies image details.
+Specifies image details.
For details, see Table 2.
Table 2 Data structure description of the images field Parameter
+Table 2 Data structure description of the images field Parameter
Type
+Type
Description
+Description
file
+file
String
+String
Specifies the URL for uploading and downloading the image file.
+Specifies the URL for uploading and downloading the image file.
owner
+owner
String
+String
Specifies the tenant to which the image belongs.
+Specifies the tenant to which the image belongs.
id
+id
String
+String
Specifies the image ID.
+Specifies the image ID.
size
+size
Long
+Long
This parameter is unavailable currently.
+This parameter is unavailable currently.
self
+self
String
+String
Specifies the image URL.
+Specifies the image URL.
schema
+schema
String
+String
Specifies the image schema.
+Specifies the image schema.
status
+status
String
+String
Specifies the image status. The value can be one of the following:
-- queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
- saving: indicates that the image file is being uploaded to the backend storage.
- deleted: indicates that the image has been deleted.
- killed: indicates that an error occurs on the image uploading.
- active: indicates that the image is available for use.
Specifies the image status. The value can be one of the following:
+- queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
- saving: indicates that the image file is being uploaded to the backend storage.
- deleted: indicates that the image has been deleted.
- killed: indicates that an error occurs on the image uploading.
- active: indicates that the image is available for use.
tags
+tags
Array of strings
+Array of strings
Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.
+Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.
visibility
+visibility
String
+String
Specifies whether the image is available to other tenants. Available values include:
+Specifies whether the image is available to other tenants. Available values include:
- private: private image
- public: public image
- shared: shared image
name
+name
String
+String
Specifies the image name. For detailed description, see Image Attributes.
+Specifies the image name. For detailed description, see Image Attributes.
checksum
+checksum
String
+String
This parameter is unavailable currently.
+This parameter is unavailable currently.
protected
+protected
Boolean
+Boolean
Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.
+Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.
container_format
+container_format
String
+String
Specifies the container type.
+Specifies the container type.
min_ram
+min_ram
Integer
+Integer
Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.
+Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.
max_ram
+max_ram
String
+String
Specifies the maximum memory (MB) of the image. You can set this parameter based on the ECS specifications. Generally, you do not need to set this parameter.
+Specifies the maximum memory (MB) of the image. You can set this parameter based on the ECS specifications. Generally, you do not need to set this parameter.
updated_at
+updated_at
String
+String
Specifies the time when the image was updated. The value is in UTC format.
+Specifies the time when the image was updated. The value is in UTC format.
__os_bit
+__os_bit
String
+String
Specifies the OS architecture, 32 bit or 64 bit.
+Specifies the OS architecture, 32 bit or 64 bit.
__os_version
+__os_version
String
+String
Specifies the OS version.
+Specifies the OS version.
__description
+__description
String
+String
Specifies the image description. For detailed description, see Image Attributes.
+Provides supplementary information about the image. For detailed description, see Image Attributes.
disk_format
+disk_format
String
+String
Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.
+Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.
__isregistered
+__isregistered
String
+String
Specifies whether the image has been registered. The value can be true or false.
+Specifies whether the image has been registered. The value can be true or false.
__platform
+__platform
String
+String
Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
+Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
__os_type
+__os_type
String
+String
Specifies the OS type. The value can be Linux, Windows, or Other.
+Specifies the OS type. The value can be Linux, Windows, or Other.
min_disk
+min_disk
Integer
+Integer
Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.
+Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.
virtual_env_type
+virtual_env_type
String
+String
Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.
+Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.
- For an ECS image, the value is FusionCompute.
- For a data disk image, the value is DataImage.
- For a BMS image, the value is Ironic.
- For an ISO image, the value is IsoImage.
__image_source_type
+__image_source_type
String
+String
Specifies the image backend storage type. Only UDS is supported currently.
+Specifies the image backend storage type. Only UDS is supported currently.
__imagetype
+__imagetype
String
+String
Specifies the image type. The following types are supported:
-- Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
Specifies the image type. The following types are supported:
+- Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
created_at
+created_at
String
+String
Specifies the time when the image was created. The value is in UTC format.
+Specifies the time when the image was created. The value is in UTC format.
virtual_size
+virtual_size
Integer
+Integer
This parameter is unavailable currently.
+This parameter is unavailable currently.
__originalimagename
+__originalimagename
String
+String
Specifies the parent image ID.
+Specifies the parent image ID.
If the image is a public image or created from an image file, this value is left empty.
__backup_id
+__backup_id
String
+String
Specifies the backup ID. To create an image using a backup, set the value to the backup ID. Otherwise, this value is left empty.
+Specifies the backup ID. To create an image using a backup, set the value to the backup ID. Otherwise, this value is left empty.
__image_size
+__image_size
String
+String
Specifies the size (bytes) of the image file.
+Specifies the size (bytes) of the image file.
__data_origin
+__data_origin
String
+String
Specifies the image source.
+Specifies the image source.
If the image is a public image, this parameter is left empty.
__lazyloading
+__lazyloading
String
+String
Specifies whether the image supports lazy loading. The value can be true, false, True, or False.
+Specifies whether the image supports lazy loading. The value can be true, false, True, or False.
active_at
+active_at
String
+String
Specifies the time when the image status became active.
+Specifies the time when the image status became active.
__os_feature_list
+__os_feature_list
String
+String
Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.
+Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.
__support_kvm
+__support_kvm
String
+String
Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.
__support_xen
+__support_xen
String
+String
Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.
__support_largememory
+__support_largememory
String
+String
Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
__support_diskintensive
+__support_diskintensive
String
+String
Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
__support_highperformance
+__support_highperformance
String
+String
Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
__support_xen_gpu_type
+__support_xen_gpu_type
String
+String
Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
__support_kvm_gpu_type
+__support_kvm_gpu_type
String
+String
Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.
-If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.
+If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
__support_xen_hana
+__support_xen_hana
String
+String
Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen and __support_kvm.
__support_kvm_infiniband
+__support_kvm_infiniband
String
+String
Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen.
enterprise_project_id
+enterprise_project_id
String
+String
Specifies the enterprise project that the image belongs to.
+Specifies the enterprise project that the image belongs to.
__root_origin
+__root_origin
String
+String
Specifies that the image is created from an external image file. Value: file
+Specifies that the image is created from an external image file. Value: file
__sequence_num
+__sequence_num
String
+String
Specifies the ECS system disk slot number corresponding to the image.
+Specifies the ECS system disk slot number of the image.
Example value: 0
__support_fc_inject
+__support_fc_inject
String
+String
Specifies whether the image supports password/private key injection using Cloud-Init.
+Specifies whether the image supports password/private key injection using Cloud-Init.
If the value is set to true, password/private key injection using Cloud-Init is not supported.
NOTE:This parameter is valid only for ECS system disk images.
hw_firmware_type
+hw_firmware_type
String
+String
Specifies the ECS boot mode. Available values include:
+Specifies the ECS boot mode. Available values include:
- bios indicates the BIOS boot mode.
- uefi indicates the UEFI boot mode.
hw_vif_multiqueue_enabled
+hw_vif_multiqueue_enabled
String
+String
Specifies whether the image supports NIC multi-queue. The value can be true or false.
+Specifies whether the image supports NIC multi-queue. The value can be true or false.
__system__cmkid
+__system__cmkid
String
+String
Specifies the ID of the key used to encrypt the image.
+Specifies the ID of the key used to encrypt the image.
__support_amd
+__support_amd
String
+String
Specifies whether the image uses AMD's x86 architecture. The value can be true or false.
+Specifies whether the image uses AMD's x86 architecture. The value can be true or false.
- Example response
STATUS CODE 200
-1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68
+ +{ - "images": [ - { - "schema": "/v2/schemas/image", - "min_disk": 100, - "created_at": "2018-09-06T14:03:27Z", - "__image_source_type": "uds", - "container_format": "bare", - "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file", - "updated_at": "2018-09-06T15:17:33Z", - "protected": true, - "checksum": "d41d8cd98f00b204e9800998ecf8427e", - "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52", - "__isregistered": "true", - "min_ram": 2048, - "__lazyloading": "true", - "owner": "1bed856811654c1cb661a6ca845ebc77", - "__os_type": "Linux", - "__imagetype": "gold", - "visibility": "public", - "virtual_env_type": "FusionCompute", - "tags": [], - "__platform": "CentOS", - "size": 0, - "__os_bit": "64", - "__os_version": "CentOS 7.3 64bit", - "name": "CentOS 7.3 64bit vivado", - "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52", - "disk_format": "zvhd2", - "virtual_size": null, - "hw_firmware_type": "bios", - "status": "active", - "__support_fc_inject":"true" - }, - { - "schema": "/v2/schemas/image", - "min_disk": 100, - "created_at": "2018-09-06T14:03:05Z", - "__image_source_type": "uds", - "container_format": "bare", - "file": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f/file", - "updated_at": "2018-09-25T14:27:40Z", - "protected": true, - "checksum": "d41d8cd98f00b204e9800998ecf8427e", - "id": "0328c25e-c840-4496-81ac-c4e01b214b1f", - "__isregistered": "true", - "min_ram": 2048, - "__lazyloading": "true", - "owner": "1bed856811654c1cb661a6ca845ebc77", - "__os_type": "Linux", - "__imagetype": "gold", - "visibility": "public", - "virtual_env_type": "FusionCompute", - "tags": [], - "__platform": "CentOS", - "size": 0, - "__os_bit": "64", - "__os_version": "CentOS 7.3 64bit", - "name": "CentOS 7.3 64bit with sdx", - "self": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f", - "disk_format": "zvhd2", - "virtual_size": null, - "hw_firmware_type": "bios", - "status": "active", - "__support_fc_inject":"true" - } - ] +
- -1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68
{ + "images": [ + { + "schema": "/v2/schemas/image", + "min_disk": 100, + "created_at": "2018-09-06T14:03:27Z", + "__image_source_type": "uds", + "container_format": "bare", + "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file", + "updated_at": "2018-09-06T15:17:33Z", + "protected": true, + "checksum": "d41d8cd98f00b204e9800998ecf8427e", + "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52", + "__isregistered": "true", + "min_ram": 2048, + "__lazyloading": "true", + "owner": "1bed856811654c1cb661a6ca845ebc77", + "__os_type": "Linux", + "__imagetype": "gold", + "visibility": "public", + "virtual_env_type": "FusionCompute", + "tags": [], + "__platform": "CentOS", + "size": 0, + "__os_bit": "64", + "__os_version": "CentOS 7.3 64bit", + "name": "CentOS 7.3 64bit vivado", + "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52", + "disk_format": "zvhd2", + "virtual_size": null, + "hw_firmware_type": "bios", + "status": "active", + "__support_fc_inject":"true" + }, + { + "schema": "/v2/schemas/image", + "min_disk": 100, + "created_at": "2018-09-06T14:03:05Z", + "__image_source_type": "uds", + "container_format": "bare", + "file": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f/file", + "updated_at": "2018-09-25T14:27:40Z", + "protected": true, + "checksum": "d41d8cd98f00b204e9800998ecf8427e", + "id": "0328c25e-c840-4496-81ac-c4e01b214b1f", + "__isregistered": "true", + "min_ram": 2048, + "__lazyloading": "true", + "owner": "1bed856811654c1cb661a6ca845ebc77", + "__os_type": "Linux", + "__imagetype": "gold", + "visibility": "public", + "virtual_env_type": "FusionCompute", + "tags": [], + "__platform": "CentOS", + "size": 0, + "__os_bit": "64", + "__os_version": "CentOS 7.3 64bit", + "name": "CentOS 7.3 64bit with sdx", + "self": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f", + "disk_format": "zvhd2", + "virtual_size": null, + "hw_firmware_type": "bios", + "status": "active", + "__support_fc_inject":"true" + } + ] } -
Returned Values
- Normal
- Abnormal
-
Returned Value
+Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
Request error. For details about the returned error code, see Error Codes.
+Request error. For details about the returned error code, see Error Codes.
401 Unauthorized
+401 Unauthorized
Authentication failed.
+Authentication failed.
403 Forbidden
+403 Forbidden
You do not have the rights to perform the operation.
+You do not have the rights to perform the operation.
404 Not Found
+404 Not Found
The requested resource was not found.
+The requested resource was not found.
500 Internal Server Error
+500 Internal Server Error
Internal service error.
+Internal service error.
503 Service Unavailable
+503 Service Unavailable
The service is unavailable.
+The service is unavailable.
Function
This API is used to query details about a public or private image.
URI
GET /v2/images/{image_id}
-Table 1 lists the parameters. +Table 1 lists the parameters in the URI.Table 1 Parameter description Parameter
Mandatory
@@ -29,525 +29,526 @@ -Request
- Request parameters -
- Example request
GET https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00-
+Request
Request parameters
+None
+Example Request
Querying details of an image
+GET https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00Response
- Response parameters
-
Parameter
+Parameter
Type
+Type
Description
+Description
file
+file
String
+String
Specifies the URL for uploading and downloading the image file.
+Specifies the URL for uploading and downloading the image file.
owner
+owner
String
+String
Specifies the tenant to which the image belongs.
+Specifies the tenant to which the image belongs.
id
+id
String
+String
Specifies the image ID.
+Specifies the image ID.
size
+size
Long
+Long
This parameter is unavailable currently.
+This parameter is unavailable currently.
self
+self
String
+String
Specifies the image URL.
+Specifies the image URL.
schema
+schema
String
+String
Specifies the image schema.
+Specifies the image schema.
status
+status
String
+String
Specifies the image status. The value can be one of the following:
+Specifies the image status. The value can be one of the following:
- queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
- saving: indicates that the image file is being uploaded to the backend storage.
- deleted: indicates that the image has been deleted.
- killed: indicates that an error occurs on the image uploading.
- active: indicates that the image is available for use.
tags
+tags
Array of strings
+Array of strings
Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.
+Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.
visibility
+visibility
String
+String
Specifies whether the image is available to other tenants. Available values include:
+Specifies whether the image is available to other tenants. Available values include:
- private: private image
- public: public image
- shared: shared image
name
+name
String
+String
Specifies the image name. For detailed description, see Image Attributes.
+Specifies the image name. For detailed description, see Image Attributes.
checksum
+checksum
String
+String
This parameter is unavailable currently.
+This parameter is unavailable currently.
protected
+protected
Boolean
+Boolean
Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.
+Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.
container_format
+container_format
String
+String
Specifies the container type.
+Specifies the container type.
min_ram
+min_ram
Integer
+Integer
Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.
+Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.
max_ram
+max_ram
String
+String
Specifies the maximum memory (MB) of the image. You can set this parameter based on the ECS specifications. Generally, you do not need to set this parameter.
+Specifies the maximum memory (MB) of the image. You can set this parameter based on the ECS specifications. Generally, you do not need to set this parameter.
updated_at
+updated_at
String
+String
Specifies the time when the image was updated. The value is in UTC format.
+Specifies the time when the image was updated. The value is in UTC format.
__os_bit
+__os_bit
String
+String
Specifies the OS architecture, 32 bit or 64 bit.
+Specifies the OS architecture, 32 bit or 64 bit.
__os_version
+__os_version
String
+String
Specifies the OS version.
+Specifies the OS version.
__description
+__description
String
+String
Specifies the image description. For detailed description, see Image Attributes.
+Specifies the image description. For detailed description, see Image Attributes.
disk_format
+disk_format
String
+String
Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.
+Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.
__isregistered
+__isregistered
String
+String
Specifies whether the image has been registered. The value can be true or false.
+Specifies whether the image has been registered. The value can be true or false.
__platform
+__platform
String
+String
Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
+Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
__os_type
+__os_type
String
+String
Specifies the OS type. The value can be Linux, Windows, or Other.
+Specifies the OS type. The value can be Linux, Windows, or Other.
__system__cmkid
+__system__cmkid
String
+String
Specifies the ID of the key used to encrypt the image.
+Specifies the ID of the key used to encrypt the image.
min_disk
+min_disk
Integer
+Integer
Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.
+Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.
virtual_env_type
+virtual_env_type
String
+String
Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.
+Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.
- For an ECS image (system disk image), the value is FusionCompute.
- For a data disk image, the value is DataImage.
- For a BMS image, the value is Ironic.
- For an ISO image, the value is IsoImage.
__image_source_type
+__image_source_type
String
+String
Specifies the backend storage of the image. Only UDS is supported currently.
+Specifies the backend storage of the image. Only UDS is supported currently.
__imagetype
+__imagetype
String
+String
Specifies the image type. The following types are supported:
+Specifies the image type. The following types are supported:
- Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
created_at
+created_at
String
+String
Specifies the time when the image was created. The value is in UTC format.
+Specifies the time when the image was created. The value is in UTC format.
virtual_size
+virtual_size
Integer
+Integer
This parameter is unavailable currently.
+This parameter is unavailable currently.
__originalimagename
+__originalimagename
String
+String
Specifies the parent image ID.
+Specifies the parent image ID.
If the image is a public image or created from an image file, this value is left empty.
__backup_id
+__backup_id
String
+String
Specifies the backup ID. To create an image using a backup, set the value to the backup ID. Otherwise, this value is left empty.
+Specifies the backup ID. To create an image using a backup, set the value to the backup ID. Otherwise, this value is left empty.
__image_size
+__image_size
String
+String
Specifies the size (bytes) of the image file. The value is greater than 0.
+Specifies the size (bytes) of the image file. The value is greater than 0.
__data_origin
+__data_origin
String
+String
Specifies the image source.
+Specifies the image source.
If the image is a public image, this parameter is left empty.
__root_origin
+__root_origin
String
+String
Specifies that the image is created from an external image file. Value: file
+Specifies that the image is created from an external image file. Value: file
__lazyloading
+__lazyloading
String
+String
Specifies whether the image supports lazy loading. The value can be true, false, True, or False.
+Specifies whether the image supports lazy loading. The value can be true, false, True, or False.
active_at
+active_at
String
+String
Specifies the time when the image status became active.
+Specifies the time when the image status became active.
__os_feature_list
+__os_feature_list
String
+String
Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.
+Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.
__sequence_num
+__sequence_num
String
+String
This parameter is unavailable currently.
+This parameter is unavailable currently.
__support_kvm
+__support_kvm
String
+String
Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.
__support_xen
+__support_xen
String
+String
Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.
__support_largememory
+__support_largememory
String
+String
Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
For the supported OSs, see Table 4.
__support_diskintensive
+__support_diskintensive
String
+String
Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
__support_highperformance
+__support_highperformance
String
+String
Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
__support_xen_gpu_type
+__support_xen_gpu_type
String
+String
Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This parameter cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This parameter cannot co-exist with __support_xen and __support_kvm.
__support_kvm_gpu_type
+__support_kvm_gpu_type
String
+String
Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.
-If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.
+If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
__support_xen_hana
+__support_xen_hana
String
+String
Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen and __support_kvm.
__support_kvm_infiniband
+__support_kvm_infiniband
String
+String
Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen.
__support_fc_inject
+__support_fc_inject
String
+String
Specifies whether the image supports password/private key injection using Cloud-Init. The parameter value can be true or false.
+Specifies whether the image supports password/private key injection using Cloud-Init. The parameter value can be true or false.
If the value is set to true, password/private key injection using Cloud-Init is not supported.
NOTE:This parameter is valid only for ECS system disk images.
enterprise_project_id
+enterprise_project_id
String
+String
Specifies the enterprise project that the image belongs to.
+Specifies the enterprise project that the image belongs to.
- If the value is 0 or left blank, the image belongs to the default enterprise project.
- If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.
For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
hw_firmware_type
+hw_firmware_type
String
+String
Specifies the ECS boot mode. Available values include:
+Specifies the ECS boot mode. Available values include:
- bios indicates the BIOS boot mode.
- uefi indicates the UEFI boot mode.
hw_vif_multiqueue_enabled
+hw_vif_multiqueue_enabled
String
+String
Specifies whether the image supports NIC multi-queue. The value can be true or false.
+Specifies whether the image supports NIC multi-queue. The value can be true or false.
__image_location
+__image_location
String
+String
Specifies the location where the image is stored.
+Specifies the location where the image is stored.
__is_config_init
+__is_config_init
String
+String
Specifies whether initial configuration is complete. The value can be true or false.
+Specifies whether initial configuration is complete. The value can be true or false.
__support_amd
+__support_amd
String
+String
Specifies whether the image uses AMD's x86 architecture. The value can be true or false.
+Specifies whether the image uses AMD's x86 architecture. The value can be true or false.
- Example response
STATUS CODE 200
-1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30
+ +{ - "schema": "/v2/schemas/image", - "min_disk": 100, - "created_at": "2018-09-06T14:03:27Z", - "__image_source_type": "uds", - "container_format": "bare", - "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file", - "updated_at": "2018-09-06T15:17:33Z", - "protected": true, - "checksum": "d41d8cd98f00b204e9800998ecf8427e", - "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52", - "__isregistered": "true", - "min_ram": 2048, - "__lazyloading": "true", - "owner": "1bed856811654c1cb661a6ca845ebc77", - "__os_type": "Linux", - "__imagetype": "gold", - "visibility": "public", - "virtual_env_type": "FusionCompute", - "tags": [], - "__platform": "CentOS", - "size": 0, - "__os_bit": "64", - "__os_version": "CentOS 7.3 64bit", - "name": "CentOS 7.3 64bit vivado", - "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52", - "disk_format": "zvhd2", - "virtual_size": null, - "status": "active" +
- -1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30
{ + "schema": "/v2/schemas/image", + "min_disk": 100, + "created_at": "2018-09-06T14:03:27Z", + "__image_source_type": "uds", + "container_format": "bare", + "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file", + "updated_at": "2018-09-06T15:17:33Z", + "protected": true, + "checksum": "d41d8cd98f00b204e9800998ecf8427e", + "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52", + "__isregistered": "true", + "min_ram": 2048, + "__lazyloading": "true", + "owner": "1bed856811654c1cb661a6ca845ebc77", + "__os_type": "Linux", + "__imagetype": "gold", + "visibility": "public", + "virtual_env_type": "FusionCompute", + "tags": [], + "__platform": "CentOS", + "size": 0, + "__os_bit": "64", + "__os_version": "CentOS 7.3 64bit", + "name": "CentOS 7.3 64bit vivado", + "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52", + "disk_format": "zvhd2", + "virtual_size": null, + "status": "active" } -
Returned Values
- Normal
- Abnormal
-
Returned Value
+Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
Request error.
+Request error.
401 Unauthorized
+401 Unauthorized
Authentication failed.
+Authentication failed.
403 Forbidden
+403 Forbidden
You do not have the rights to perform the operation.
+You do not have the rights to perform the operation.
404 Not Found
+404 Not Found
The requested resource was not found.
+The requested resource was not found.
500 Internal Server Error
+500 Internal Server Error
Internal service error.
+Internal service error.
503 Service Unavailable
+503 Service Unavailable
The service is unavailable.
+The service is unavailable.
Updating Image Information
-Function
This API is used to modify image attributes and update image information.
-
Only information of images in active status can be changed.
+Function
This API is used to update image information.
+ Only active images can be updated.
+URI
PATCH /v2/cloudimages/{image_id}
-Table 1 describes the parameters in the URI.
+Table 1 lists the parameters in the URI.
-
-Table 1 Parameter description Parameter
String
Specifies the name of the attribute to be modified. / needs to be added in front of it.
-You can modify the following attributes:
+Specifies the name of the attribute to be updated. / needs to be added in front of it.
+You can update the following attributes:
- name: specifies the image name.
- __description: specifies the image description.
- __support_xen: Xen is supported.
- __support_largememory: Ultra-large memory is supported.
- __support_diskintensive: Intensive storage is supported.
- __support_highperformance: High-performance computing (HPC) is supported.
- __support_xen_gpu_type: GPU-accelerated ECSs that use Xen for virtualization are supported.
- __support_kvm_gpu_type: GPU-accelerated ECSs that use KVM for virtualization are supported.
- __support_xen_hana: HANA ECSs that use Xen for virtualization are supported.
- __is_config_init: specifies whether initialization configuration is complete.
- enterprise_project_id: specifies the enterprise project ID.
- min_ram: specifies the minimum memory.
- hw_vif_multiqueue_enabled: The NIC multi-queue feature is supported.
- hw_firmware_type: specifies the boot mode. The value can be bios or uefi.
You can add or delete extension attributes.
- Example request
PATCH https://{Endpoint}/v2/cloudimages/33ad552d-1149-471c-8190-ff6776174a00--1 -2 -3 -4 -5 -6 -7
[ - { - "op": "replace", - "path": "/name", - "value": "ims_test" - } -] -
Example Request
Changing an image name to ims_test
++1 +2 +3 +4 +5 +6 +7 +8
+PATCH https://{Endpoint}/v2/cloudimages/33ad552d-1149-471c-8190-ff6776174a00 +[ + { + "op": "replace", + "path": "/name", + "value": "ims_test" + } +] +
Response
- Response parameters
-
Parameter
+Parameter
Type
+Type
Description
+Description
file
+file
String
+String
Specifies the URL for uploading and downloading the image file.
+Specifies the URL for uploading and downloading the image file.
owner
+owner
String
+String
Specifies the tenant to which the image belongs.
+Specifies the tenant to which the image belongs.
id
+id
String
+String
Specifies the image ID.
+Specifies the image ID.
size
+size
Long
+Long
This parameter is unavailable currently.
+This parameter is unavailable currently.
self
+self
String
+String
Specifies the image URL.
+Specifies the image URL.
schema
+schema
String
+String
Specifies the image schema.
+Specifies the image schema.
status
+status
String
+String
Specifies the image status. The value can be one of the following:
+Specifies the image status. The value can be one of the following:
- queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
- saving: indicates that the image file is being uploaded to the backend storage.
- deleted: indicates that the image has been deleted.
- killed: indicates that an error occurs on the image uploading.
- active: indicates that the image is available for use.
tags
+tags
Array of strings
+Array of strings
Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.
+Specifies tags of the image, through which you can manage private images in your own way. You can use the image tag API to add different tags to each image and filter images by tag.
visibility
+visibility
String
+String
Specifies whether the image is available to other tenants. The value can be one of the following:
+Specifies whether the image is available to other tenants. The value can be one of the following:
- private: private image
- public: public image
- shared: shared image
name
+name
String
+String
Specifies the image name. For detailed description, see Image Attributes.
+Specifies the image name. For detailed description, see Image Attributes.
checksum
+checksum
String
+String
This parameter is unavailable currently.
+This parameter is unavailable currently.
protected
+protected
Boolean
+Boolean
Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.
+Specifies whether the image is protected. A protected image cannot be deleted. The value can be true or false.
container_format
+container_format
String
+String
Specifies the container type.
+Specifies the container type.
min_ram
+min_ram
Integer
+Integer
Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. The default value is 0.
+Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. The default value is 0.
max_ram
+max_ram
String
+String
Specifies the maximum memory (MB) of the image. The parameter value depends on the ECS specifications and is not configured by default.
+Specifies the maximum memory (MB) of the image. The parameter value depends on the ECS specifications and is not configured by default.
updated_at
+updated_at
String
+String
Specifies the time when the image was updated. The value is in UTC format.
+Specifies the time when the image was updated. The value is in UTC format.
__os_bit
+__os_bit
String
+String
Specifies the OS architecture, 32 bit or 64 bit.
+Specifies the OS architecture, 32 bit or 64 bit.
__os_version
+__os_version
String
+String
Specifies the OS version.
+Specifies the OS version.
__description
+__description
String
+String
Provides supplementary information about the image. For detailed description, see Image Attributes.
+Provides supplementary information about the image. For detailed description, see Image Attributes.
disk_format
+disk_format
String
+String
Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.
+Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.
__isregistered
+__isregistered
String
+String
Specifies whether the image has been registered. The value can be true or false.
+Specifies whether the image has been registered. The value can be true or false.
__platform
+__platform
String
+String
Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
+Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
__os_type
+__os_type
String
+String
Specifies the OS type. The value can be Linux, Windows, or Other.
+Specifies the OS type. The value can be Linux, Windows, or Other.
__system__cmkid
+__system__cmkid
String
+String
Specifies the ID of the key used to encrypt the image.
+Specifies the ID of the key used to encrypt the image.
min_disk
+min_disk
Integer
+Integer
Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.
+Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1,024 GB.
virtual_env_type
+virtual_env_type
String
+String
Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.
-- For an ECS image (system disk image), the value is FusionCompute.
- For a data disk image, the value is DataImage.
- For a BMS image, the value is Ironic.
- For an ISO image, the value is IsoImage.
Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.
+- For an ECS image (system disk image), the value is FusionCompute.
- For a data disk image, the value is DataImage.
- For a BMS image, the value is Ironic.
- For an ISO image, the value is IsoImage.
__image_source_type
+__image_source_type
String
+String
Specifies the backend storage of the image. Only UDS is supported currently.
+Specifies the backend storage of the image. Only UDS is supported currently.
__imagetype
+__imagetype
String
+String
Specifies the image type. The following types are supported:
+Specifies the image type. The following types are supported:
- Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
created_at
+created_at
String
+String
Specifies the time when the image was created. The value is in UTC format.
+Specifies the time when the image was created. The value is in UTC format.
virtual_size
+virtual_size
Integer
+Integer
This parameter is unavailable currently.
+This parameter is unavailable currently.
__originalimagename
+__originalimagename
String
+String
Specifies the parent image ID.
+Specifies the parent image ID.
If the image is a public image or created from an image file, this value is left empty.
__backup_id
+__backup_id
String
+String
Specifies the backup ID. If the image is created from a backup, set the value to the backup ID. Otherwise, this parameter is not required.
+Specifies the backup ID. If the image is created from a backup, set the value to the backup ID. Otherwise, this parameter is not required.
__image_size
+__image_size
String
+String
Specifies the size (bytes) of the image file. The value must be greater than 0.
+Specifies the size (bytes) of the image file. The value must be greater than 0.
__data_origin
+__data_origin
String
+String
Specifies the image source.
+Specifies the image source.
If the image is a public image, this parameter is left empty.
__root_origin
+__root_origin
String
+String
Specifies that the image is created from an external image file. Value: file
+Specifies that the image is created from an external image file. Value: file
__lazyloading
+__lazyloading
String
+String
Specifies whether the image supports lazy loading. The value can be true, false, True, or False.
+Specifies whether the image supports lazy loading. The value can be true, false, True, or False.
active_at
+active_at
String
+String
Specifies the time when the image status became active.
+Specifies the time when the image status became active.
__os_feature_list
+__os_feature_list
String
+String
Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.
+Specifies additional attributes of the image. The value is a list (in JSON format) of advanced features supported by the image.
__account_code
+__account_code
String
+String
Specifies the charging identifier for the image.
+Specifies the charging identifier for the image.
hw_firmware_type
+hw_firmware_type
String
+String
Specifies the ECS boot mode. The following values are supported:
+Specifies the ECS boot mode. The following values are supported:
- bios indicates the BIOS boot mode. This value will be used by fault if this parameter does not exist in the response.
- uefi indicates the UEFI boot mode.
hw_vif_multiqueue_enabled
+hw_vif_multiqueue_enabled
String
+String
Specifies whether the image supports NIC multi-queue. The value can be true or false.
+Specifies whether the image supports NIC multi-queue. The value can be true or false.
__support_kvm
+__support_kvm
String
+String
Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.
__support_xen
+__support_xen
String
+String
Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.
__support_largememory
+__support_largememory
String
+String
Specifies whether the image can be used to create large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image can be used to create large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
For the supported OSs, see Table 4.
__support_diskintensive
+__support_diskintensive
String
+String
Specifies whether the image can be used to create disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image can be used to create disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
__support_highperformance
+__support_highperformance
String
+String
Specifies whether the image can be used to create high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image can be used to create high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
__support_xen_gpu_type
+__support_xen_gpu_type
String
+String
Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
__support_kvm_gpu_type
+__support_kvm_gpu_type
String
+String
Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.
-If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value.
+If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
__support_xen_hana
+__support_xen_hana
String
+String
Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen and __support_kvm.
__support_kvm_infiniband
+__support_kvm_infiniband
String
+String
Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+Specifies whether the image supports ECSs with InfiniBand NICs on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen.
enterprise_project_id
+enterprise_project_id
String
+String
Specifies the enterprise project that the image belongs to.
+Specifies the enterprise project that the image belongs to.
__sequence_num
+__sequence_num
String
+String
Specifies the ECS system disk slot number corresponding to the image.
+Specifies the ECS system disk slot number of the image.
This parameter is unavailable currently.
__support_fc_inject
+__support_fc_inject
String
+String
Specifies whether the image supports password/private key injection using Cloud-Init.
+Specifies whether the image supports password/private key injection using Cloud-Init.
If the value is set to true, password/private key injection using Cloud-Init is not supported.
NOTE:This parameter is valid only for ECS system disk images.
__support_amd
+__support_amd
String
+String
Specifies whether the image uses AMD's x86 architecture. The value can be true or false.
+Specifies whether the image uses AMD's x86 architecture. The value can be true or false.
- Example response
STATUS CODE 200
-1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38
+ +{ - "file": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00/file", - "owner": "0b1e494e2660441a957313163095fe5c", - "id": "33ad552d-1149-471c-8190-ff6776174a00", - "size": 2, - "self": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00", - "schema": "/v2/schemas/image", - "status": "active", - "tags": [], - "visibility": "private", - "name": "ims_test", - "checksum": "99914b932bd37a50b983c5e7c90ae93b", - "hw_vif_multiqueue_enabled": "true", - "protected": false, - "container_format": "bare", - "min_ram": 0, - "updated_at": "2015-12-08T02:30:49Z", - "__os_bit": "64", - "__os_version": "Ubuntu 14.04 server 64bit", - "__description": "ims test", - "disk_format": "vhd", - "__isregistered": "true", - "__platform": "Ubuntu", - "__os_type": "Linux", - "min_disk": 40, - "virtual_env_type": "FusionCompute", - "__image_source_type": "uds", - "__imagetype": "private", - "created_at": "2015-12-04T09:45:33Z", - "virtual_size": 0, - "__originalimagename": "33ad552d-1149-471c-8190-ff6776174a00", - "__backup_id": "", - "__productcode": "", - "__image_size": "449261568", - "__support_fc_inject":"true", - "__data_origin": null, - "hw_firmware_type": "bios" +
- -1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38
{ + "file": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00/file", + "owner": "0b1e494e2660441a957313163095fe5c", + "id": "33ad552d-1149-471c-8190-ff6776174a00", + "size": 2, + "self": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00", + "schema": "/v2/schemas/image", + "status": "active", + "tags": [], + "visibility": "private", + "name": "ims_test", + "checksum": "99914b932bd37a50b983c5e7c90ae93b", + "hw_vif_multiqueue_enabled": "true", + "protected": false, + "container_format": "bare", + "min_ram": 0, + "updated_at": "2015-12-08T02:30:49Z", + "__os_bit": "64", + "__os_version": "Ubuntu 14.04 server 64bit", + "__description": "ims test", + "disk_format": "vhd", + "__isregistered": "true", + "__platform": "Ubuntu", + "__os_type": "Linux", + "min_disk": 40, + "virtual_env_type": "FusionCompute", + "__image_source_type": "uds", + "__imagetype": "private", + "created_at": "2015-12-04T09:45:33Z", + "virtual_size": 0, + "__originalimagename": "33ad552d-1149-471c-8190-ff6776174a00", + "__backup_id": "", + "__productcode": "", + "__image_size": "449261568", + "__support_fc_inject":"true", + "__data_origin": null, + "hw_firmware_type": "bios" } -
Returned Values
- Normal
- Abnormal
-
Returned Value
+Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
Request error. For details about the returned error code, see Error Codes.
+Request error. For details about the returned error code, see Error Codes.
401 Unauthorized
+401 Unauthorized
Authentication failed.
+Authentication failed.
403 Forbidden
+403 Forbidden
You do not have the rights to perform the operation.
+You do not have the rights to perform the operation.
404 Not Found
+404 Not Found
The requested resource was not found.
+The requested resource was not found.
500 Internal Server Error
+500 Internal Server Error
Internal service error.
+Internal service error.
503 Service Unavailable
+503 Service Unavailable
The service is unavailable.
+The service is unavailable.
Request
- Request parameters
-
Parameter
+Request
Request parameters ++-Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
delete_backup
+delete_backup
No
+No
Boolean
+Boolean
Specifies whether to delete the CSBS backups or CBR backups associated with a full-ECS image when the image is deleted. The value can be true or false.
+Specifies whether to delete the CSBS backups or CBR backups associated with a full-ECS image when the image is deleted. The value can be true or false.
- true: When a full-ECS image is deleted, its CSBS backups or CBR backups are also deleted.
- false: When a full-ECS image is deleted, its CSBS backups or CBR backups are not deleted.
- Example request
+DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90---1 -2 -3
{ - "delete_backup": true -} -
Example Request
Deleting an image
+1 +2 +3 +4
+DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90 +{ + "delete_backup": true +} +
Returned Values
- Normal
- Abnormal
-
Returned Value
+-Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
Request error.
+Request error.
401 Unauthorized
+401 Unauthorized
Authentication failed.
+Authentication failed.
403 Forbidden
+403 Forbidden
You do not have the rights to perform the operation.
+You do not have the rights to perform the operation.
404 Not Found
+404 Not Found
The requested resource was not found.
+The requested resource was not found.
500 Internal Server Error
+500 Internal Server Error
Internal service error.
+Internal service error.
503 Service Unavailable
+503 Service Unavailable
The service is unavailable.
+The service is unavailable.
Creating an Image
-Function
This API is used to create a private image. The following methods are supported:
- Create a system or data disk image from an ECS.
- Create a system disk image from an external image file uploaded to an OBS bucket.
- Create a system disk image from a data disk.
The API is an asynchronous one. If it is successfully called, the cloud service system receives the request. However, you need to use the asynchronous job query API to query the image creation status. For details, see Asynchronous Job Query.
+The API is an asynchronous one. If it is successfully called, the cloud service system receives the request. However, you need to use the asynchronous job query API to query the image creation status. For details, see Querying the Status of an Asynchronous Job.
You cannot export public images (such as Windows, SUSE, Red Hat, Oracle Linux, and Ubuntu) or private images created using these public images.
Constraints (Creating a System Disk Image Using a Data Disk)
- Before using a data disk to create a system disk image, ensure that an OS has been installed on the data disk and has been optimized. For details about the optimization, see "Optimizing a Windows Private Image" and "Optimizing a Linux Private Image" in the Image Management Service User Guide.
- The system cannot verify that an OS has been installed on the data disk. Therefore, ensure that the value of os_version is valid when creating a system disk image from the data disk. For details, see Values of Related Parameters.
Constraints (Creating a System Disk Image Using a Data Disk)
- Before using a data disk to create a system disk image, ensure that an OS has been installed on the data disk and has been optimized. For details about the optimization, see "Optimizing a Windows Private Image" and "Optimizing a Linux Private Image" in the Image Management Service User Guide.
- The system cannot verify that an OS has been installed on the data disk. Therefore, ensure that the value of os_version is valid when creating a system disk image from the data disk. For details, see Values of Related Parameters.
@@ -36,7 +36,7 @@URI
POST /v2/cloudimages/action
String
Specifies the image description. For details, see Image Attributes. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.
+Provides supplementary information about the image. For details, see Image Attributes. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.
instance_id
@@ -68,7 +68,7 @@Array of strings
Specifies tags of the image. This parameter is left blank by default.
+Lists the image tags. This parameter is left blank by default.
Use either tags or image_tags.
Array of objects
Specifies tags of the image. This parameter is left blank by default.
-Use either tags or image_tags.
+Lists the image tags. This parameter is left blank by default.
+Use either tags or image_tags.
enterprise_project_id
@@ -190,7 +190,7 @@String
Specifies the image description. For detailed description, see Image Attributes. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.
+Provides supplementary information about the image. For detailed description, see Image Attributes. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.
os_type
@@ -239,7 +239,7 @@Integer
Specifies the minimum size of the system disk in the unit of GB.
-This parameter is mandatory if an external image file in the OBS bucket is used to create an image. The value ranges from 1 GB to 1024 GB.
+This parameter is mandatory if an external image file in the OBS bucket is used to create an image. The value ranges from 1 GB to 1,024 GB.
is_config
@@ -260,7 +260,7 @@String
Specifies the master key used for encrypting an image. For its value, see the Key Management Service User Guide.
+Specifies a custom key used for encrypting an image. For its value, see the Key Management Service User Guide.
tags
@@ -269,7 +269,7 @@Array of strings
Specifies tags of the image. The value is left blank by default.
+Lists the image tags. This parameter is left blank by default.
Use either tags or image_tags.
Array of objects
Specifies tags of the image. This parameter is left blank by default. Use either tags or image_tags.
+Lists the image tags. This parameter is left blank by default. Use either tags or image_tags.
type
@@ -300,7 +300,7 @@String
Specifies the enterprise project that the image belongs to.
-- If the value is 0 or left blank, the image belongs to the default enterprise project.
- If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.
For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
+- If the value is 0 or left blank, the image belongs to the default enterprise project.
- If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.
For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
Integer
Specifies the minimum memory required by the image in the unit of MB. The default value is 0, indicating that the memory is not restricted.
+Specifies the minimum memory required by the image in the unit of MB. The default value is 0, indicating that the memory is not restricted.
data_images
@@ -376,7 +376,7 @@String
Specifies the image description. The value is left blank by default.
+Provides supplementary information about the image. This parameter is left blank by default.
The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (< >) are not allowed.
For more details, see Image Attributes.
Array of strings
Specifies tags of the image. The value is left blank by default.
+Lists the image tags. This parameter is left blank by default.
For detailed parameter descriptions, see Image Tag Data Formats.
-Use either tags or image_tags.
+Use either tags or image_tags.
image_tags
@@ -437,7 +437,7 @@Array of objects
Specifies tags of the image. The value is left blank by default.
+Lists the image tags. This parameter is left blank by default.
For detailed parameter descriptions, see Image Tag Data Formats.
Use either tags or image_tags.
Array of strings
Specifies tags of the image. This parameter is left blank by default.
-Use either tags or image_tags.
+Use either tags or image_tags.
image_tags
@@ -546,7 +546,7 @@Array of objects
Specifies tags of the image. This parameter is left blank by default.
-Use either tags or image_tags.
+Use either tags or image_tags.
enterprise_project_id
@@ -556,15 +556,17 @@String
Specifies the enterprise project that the image belongs to.
-- If the value is 0 or left blank, the image belongs to the default enterprise project.
- If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.
For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
+- If the value is 0 or left blank, the image belongs to the default enterprise project.
- If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.
For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
- Example requests
- Request for creating a system disk image with parameter tags using an ECS
POST https://{Endpoint}/v2/cloudimages/action-{ +
Example Request
- Creating a system disk image with parameter tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
POST https://{Endpoint}/v2/cloudimages/action +{ "name": "ims_test", "description": "Create a system disk image from an ECS", "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", @@ -574,61 +576,61 @@ "ccc.444" ] }- - Request for creating a data disk image with parameter tags using the data disk of an ECS
POST https://{Endpoint}/v2/cloudimages/action--1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11
-{ - "data_images": [{"name": "ims_data_image_test", - "description": "Create a data disk image from the data disk of an ECS", - "volume_id": "c5dfbd0c-bf0a-4798-a453-61dc6b54aa30", - "tags": [ - "aaa.111", - "bbb.333", - "ccc.444" - ] - }] +
- Creating a data disk image with parameter tags using a data disk (ID: c5dfbd0c-bf0a-4798-a453-61dc6b54aa30) of an ECS
- -1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12
POST https://{Endpoint}/v2/cloudimages/action +{ + "data_images": [{"name": "ims_data_image_test", + "description": "Create a data disk image from the data disk of an ECS", + "volume_id": "c5dfbd0c-bf0a-4798-a453-61dc6b54aa30", + "tags": [ + "aaa.111", + "bbb.333", + "ccc.444" + ] + }] } -
- Request for creating an image with parameter tags using an external image file uploaded to the OBS bucket
POST https://{Endpoint}/v2/cloudimages/action-+ ++1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11 -12
+{ - "name": "ims_test_file", - "description": "Create an image from a file in the OBS bucket", - "image_url": "ims-image:centos70.qcow2", - "os_version": "CentOS 7.0 64bit", - "min_disk": 40, - "tags": [ - "aaa.111", - "bbb.333", - "ccc.444" - ] +
- Creating an image with parameter tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.qcow2)
- -1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13
POST https://{Endpoint}/v2/cloudimages/action +{ + "name": "ims_test_file", + "description": "Create an image from a file in an OBS bucket", + "image_url": "ims-image:centos70.qcow2", + "os_version": "CentOS 7.0 64bit", + "min_disk": 40, + "tags": [ + "aaa.111", + "bbb.333", + "ccc.444" + ] } -
- Request for creating a system disk image with parameter image_tags using an ECS
POST https://{Endpoint}/v2/cloudimages/action-{ +- Creating a system disk image with parameter image_tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
POST https://{Endpoint}/v2/cloudimages/action +{ "name": "ims_test", "description": "Create a system disk image from an ECS", "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", @@ -643,158 +645,156 @@ } ] }- - Request for creating a data disk image with parameter image_tags using the data disk of an ECS
POST /v2/cloudimages/action
-+1 -2 -3 -4 -5 -6 -7
-{ - "data_images": [{"name": "ims_data_image_test", - "description": "Create a data disk image from the data disk of an ECS", - "volume_id": "c5dfbd0c-bf0a-4798-a453-61dc6b54aa30", - "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] - }] +
- Creating a data disk image with parameter image_tags using a data disk (ID: c5dfbd0c-bf0a-4798-a453-61dc6b54aa30) of an ECS
- -1 +2 +3 +4 +5 +6 +7 +8
POST /v2/cloudimages/action +{ + "data_images": [{"name": "ims_data_image_test", + "description": "Create a data disk image from the data disk of an ECS", + "volume_id": "c5dfbd0c-bf0a-4798-a453-61dc6b54aa30", + "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] + }] } -
- Request for creating an image with parameter image_tags using an external image file uploaded to the OBS bucket
POST https://{Endpoint}/v2/cloudimages/action--+1 -2 -3 -4 -5 -6 -7 -8
+{ - "name": "ims_test_file", - "description": "Create an image from a file in the OBS bucket", - "image_url": "ims-image:centos70.qcow2", - "os_version": "CentOS 7.0 64bit", - "min_disk": 40, - "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] +
- Creating an image with parameter image_tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.qcow2)
- -1 +2 +3 +4 +5 +6 +7 +8 +9
POST https://{Endpoint}/v2/cloudimages/action +{ + "name": "ims_test_file", + "description": "Create an image from a file in an OBS bucket", + "image_url": "ims-image:centos70.qcow2", + "os_version": "CentOS 7.0 64bit", + "min_disk": 40, + "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] } -
- Request for creating a system disk image with parameter tags using a data disk
POST https://{Endpoint}/v2/cloudimages/action--- -1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11 -12
{ - "name": "ims_test", - "description": "Create a system disk image from a data disk", - "volume_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", - "type": "ECS", - "os_version": "CentOS 7.0 64bit", - "tags": [ - "aaa.111", - "bbb.333", - "ccc.444" - ] - } -
- Request for creating a system disk image with parameter image_tags using a data disk
+ +POST https://{Endpoint}/v2/cloudimages/action--- -1 -2 -3 -4 -5 -6 -7 -8
{ - "name": "ims_test", - "description": "Create a system disk image from a data disk", - "volume_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", - "type": "ECS", - "os_version": "CentOS 7.0 64bit", - "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] - } -
- Creating a system disk image with parameter tags using a data disk (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13
+POST https://{Endpoint}/v2/cloudimages/action +{ + "name": "ims_test", + "description": "Create a system disk image from a data disk", + "volume_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", + "type": "ECS", + "os_version": "CentOS 7.0 64bit", + "tags": [ + "aaa.111", + "bbb.333", + "ccc.444" + ] + } +
- Creating a system disk image with parameter image_tags using a data disk (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
1 +2 +3 +4 +5 +6 +7 +8 +9
+POST https://{Endpoint}/v2/cloudimages/action +{ + "name": "ims_test", + "description": "Create a system disk image from a data disk", + "volume_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a", + "type": "ECS", + "os_version": "CentOS 7.0 64bit", + "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] + } +
Response
- Response parameters
-
Parameter
+Parameter
Type
+Type
Description
+Description
job_id
+job_id
String
+String
Specifies the asynchronous job ID.
-For details, see Asynchronous Job Query.
+Specifies the asynchronous job ID.
+For details, see Querying the Status of an Asynchronous Job.
- Example response
STATUS CODE 200
-1 -2 -3
+ +{ - "job_id": "8a12fc664fb4daa3014fb4e581380005" +
- -1 +2 +3
{ + "job_id": "8a12fc664fb4daa3014fb4e581380005" } -
Returned Values
- Normal
- Abnormal
-
Returned Value
+Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
Request error. For details about the returned error code, see Error Codes.
+Request error. For details about the returned error code, see Error Codes.
401 Unauthorized
+401 Unauthorized
Authentication failed.
+Authentication failed.
403 Forbidden
+403 Forbidden
You do not have the rights to perform the operation.
+You do not have the rights to perform the operation.
404 Not Found
+404 Not Found
The requested resource was not found.
+The requested resource was not found.
500 Internal Server Error
+500 Internal Server Error
Internal service error.
+Internal service error.
503 Service Unavailable
+503 Service Unavailable
The service is unavailable.
+The service is unavailable.
Request
- Request parameters -
- Example request
PUT https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags/aaaa-
+Request
Request parameters
+None
+Example Request
Adding an image tag
+PUT https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags/aaaaReturned Values
- Normal
- Abnormal
-
Returned Value
+Returned Value
Description
+Description
400 Bad Request
+400 Bad Request
Request error.
+Request error.
401 Unauthorized
+401 Unauthorized
Authentication failed.
+Authentication failed.
403 Forbidden
+403 Forbidden
You do not have the rights to perform the operation.
+You do not have the rights to perform the operation.
404 Not Found
+404 Not Found
The requested resource was not found.
+The requested resource was not found.
500 Internal Server Error
+500 Internal Server Error
Internal service error.
+Internal service error.
503 Service Unavailable
+503 Service Unavailable
The service is unavailable.
+The service is unavailable.
Asynchronous Job Query
+Querying the Status of an Asynchronous Job
-Function
This is an extension API. It is used to query for the execution status of an asynchronous job, for example, querying for the execution status of an image exporting job.
URI
GET /v1/{project_id}/jobs/{job_id}
@@ -32,75 +32,77 @@Request
- Request parameters -
- Example request
GET /v1/ac234de25c6741d2b1273da49eea1b9e/jobs/ff8080814dbd65d7014dbe0d84db0013
-
+Request
Request parameters
+None
+Example Request
Querying the status of an asynchronous job
+GET /v1/ac234de25c6741d2b1273da49eea1b9e/jobs/ff8080814dbd65d7014dbe0d84db0013
Response
- Response parameters
-
Parameter
+-Parameter
Type
+Type
Description
+Description
status
+status
String
+String
Specifies the job status. The value can be:
+Specifies the job status. The value can be:
- SUCCESS: The job is successfully executed.
- FAIL: The job failed to be executed.
- RUNNING: The job is in progress.
- INIT: The job is being initialized.
job_id
+job_id
String
+String
Specifies the job ID.
+Specifies the job ID.
job_type
+job_type
String
+String
Specifies the job type.
+Specifies the job type.
- imsCreateImageByInstance: Creating a system disk image from a cloud server
- imsImportImageJob: Creating a system disk image from an external image file
- imsImportOvaImageJob: Creating an image from an OVA image file
- imsVolumeCreateImageJob: Creating a data disk image from a cloud server
- imsImportDataImageJob: Creating a data disk image from an external image file
- imsCreateWholeImageByInstanceJob: Creating a full-ECS image from an ECS
- imsCreateWholeImageByBackupJob: Creating a full-ECS image from a CBR or CSBS backup
- imsNativeImportImageJob: Registering an image
- imsNativeExportImageJob: Exporting image
- imsAddImageMembersJob: Adding tenants that can use a shared image
- imsDelImageMembersJob: Deleting tenants that can use a shared image
- imsUpdateImageMembersJob: Updating status of tenants who will accept or reject shared images
- imsCopyImageInRegionJob: Replicating images
begin_time
+begin_time
String
+String
Specifies the start time of the job. The value is in UTC format.
+Specifies the start time of the job. The value is in UTC format.
end_time
+end_time
String
+String
Specifies the end time of the job. The value is in UTC format.
+Specifies the end time of the job. The value is in UTC format.
error_code
+error_code
String
+String
Specifies the error code.
+Specifies the error code.
fail_reason
+fail_reason
String
+String
Specifies the failure cause.
+Specifies the failure cause.
entities
+entities
Object
+Object
Specifies the custom attributes of the job.
+Specifies the custom attributes of the job.
If the job status is normal, the image ID will be returned. If the status is abnormal, an error code and details will be returned.
For details, see Table 2.
Table 2 Data structure description of the entities field Parameter
+-Table 2 Data structure description of the entities field Parameter
Type
+Type
Description
+Description
image_id
+image_id
String
+String
Specifies the image ID.
+Specifies the image ID.
current_task
+current_task
String
+String
Specifies the job name.
+Specifies the job name.
image_name
+image_name
String
+String
Specifies the image name.
+Specifies the image name.
process_percent
+process_percent
Double
+Double
Specifies the job progress.
+Specifies the job progress.
results
+results
Array of result objects
+Array of result objects
Specifies job execution results. For details, see Table 3.
+Specifies job execution results. For details, see Table 3.
sub_jobs_result
+sub_jobs_result
Array of SubJobResult objects
+Array of objects
Specifies sub-job execution results. For details, see Table 4.
+Specifies sub-job execution results. For details, see Table 4.
sub_jobs_list
+sub_jobs_list
Array of string
+Array of string
Specifies the sub-job IDs.
+Specifies the sub-job IDs.
Table 3 Data structure description of the result field Parameter
+-Table 3 Data structure description of the result field Parameter
Type
+Type
Description
+Description
image_id
+image_id
String
+String
Specifies the image ID.
+Specifies the image ID.
project_id
+project_id
String
+String
Specifies the project ID.
+Specifies the project ID.
status
+status
String
+String
Specifies the job status.
+Specifies the job status.
Table 4 Data structure description of the SubJobResult field Parameter
+-Table 4 Data structure description of the SubJobResult field Parameter
Type
+Type
Description
+Description
status
+status
String
+String
Specifies the sub-job status. The value can be:
-- SUCCESS: The sub-job is successfully executed.
- FAIL: The sub-job failed to be executed.
- RUNNING: The sub-job is in progress.
- INIT: The sub-job is being initialized.
Specifies the sub-job status. The value can be:
+- SUCCESS: The sub-job is successfully executed.
- FAIL: The sub-job failed to be executed.
- RUNNING: The sub-job is in progress.
- INIT: The sub-job is being initialized.
job_id
+job_id
String
+String
Specifies a sub-job ID.
+Specifies a sub-job ID.
job_type
+job_type
String
+String
Specifies the sub-job type.
+Specifies the sub-job type.
begin_time
+begin_time
String
+String
Specifies the start time of the sub-job. The value is in UTC format.
+Specifies the start time of the sub-job. The value is in UTC format.
end_time
+end_time
String
+String
Specifies the end time of the sub-job. The value is in UTC format.
+Specifies the end time of the sub-job. The value is in UTC format.
error_code
+error_code
String
+String
Specifies the error code.
+Specifies the error code.
fail_reason
+fail_reason
String
+String
Specifies the failure cause.
+Specifies the failure cause.
entities
+entities
Object SubJobEntities
+Object
Specifies the custom attributes of the sub-job. For details, see Table 5.
+Specifies the custom attributes of the sub-job. For details, see Table 5.
- If a sub-job is properly executed, an image ID is returned.
- If an exception occurs on the sub-job, an error code and associated information are returned.
- Example response
- Creating a data disk image with parameter image_tags using a data disk (ID: c5dfbd0c-bf0a-4798-a453-61dc6b54aa30) of an ECS
- Creating a system disk image with parameter image_tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
- Creating a data disk image with parameter tags using a data disk (ID: c5dfbd0c-bf0a-4798-a453-61dc6b54aa30) of an ECS
- Request parameters
-
- Example response
- Response parameters
-
- Example response
- Querying an Image List Schema (Native OpenStack API)