diff --git a/docs/ims/api-ref/en-us_topic_0020091555.html b/docs/ims/api-ref/en-us_topic_0020091555.html index 0dd2872b..f7105988 100644 --- a/docs/ims/api-ref/en-us_topic_0020091555.html +++ b/docs/ims/api-ref/en-us_topic_0020091555.html @@ -100,393 +100,394 @@
  • 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

  • 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

  • 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

  • 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

    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
+
    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"
-    }
+    {
+        "op": "replace",
+        "path": "/name",
+        "value": "ims_test"
+    }
 ]
-
    
-
    
+
    + +

    Response

    Returned Values

    Example Request

    Deleting an image

    -
    1
-2
-3
-4
    DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
+
    1
+2
+3
+4
    DELETE https://{Endpoint}/v2/images/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
 {
-    "delete_backup": true
+    "delete_backup": true
 }
-
    
-
    
+
    + +

    Response

    -

    Constraints (Creating a System Disk Image Using a Data Disk)

    +

    Constraints (Creating a System Disk Image Using a Data Disk)

    URI

    POST /v2/cloudimages/action

    @@ -79,7 +79,7 @@

    Array of objects

    Lists the image tags. This parameter is left blank by default.

    -

    Use either tags or image_tags.

    +

    Use either tags or image_tags.

    enterprise_project_id

    @@ -261,7 +261,7 @@

    String

    -

    Specifies a custom 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

    @@ -280,7 +280,7 @@

    Array of objects

    -

    Lists the image tags. 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

    @@ -290,7 +290,7 @@

    String

    Specifies the image type.

    -

    The value can be ECS, BMS, FusionCompute, IsoImage, or Ironic. The default value is ECS.

    +

    The value can be ECS, BMS, FusionCompute, IsoImage, or Ironic. The default value is ECS.

    @@ -301,7 +301,7 @@

    String

    Specifies the enterprise project that the image belongs to.

    -

    Response

  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "8a12fc664fb4daa3014fb4e581380005"
+
    1
+2
+3
    {
+    "job_id": "8a12fc664fb4daa3014fb4e581380005"
 }
-
    
-
    
+
    + +

    • Returned Values

    Returned Values

    Response

    Returned Values

    Example Request

    Adding a tenant who can use the shared image (project ID: edc89b490d7d4392898e19b2deb34797)

    -
    1
-2
-3
-4
    POST https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members
+
    1
+2
+3
+4
    POST https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members
 {
-    "member":"edc89b490d7d4392898e19b2deb34797"
+    "member":"edc89b490d7d4392898e19b2deb34797"
 }
-
    
-
    
+
    + +

    Response

    Returned Values

    -

    Example Request

    Response

  • Example response
    STATUS CODE 200
    -
    1
-2
-3
-4
-5
-6
-7
-8
    {
-    "status": "accepted",
-    "created_at": "2016-09-01T02:05:14Z",
-    "updated_at": "2016-09-01T02:37:11Z",
-    "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-    "member_id": "edc89b490d7d4392898e19b2deb34797",
-    "schema": "/v2/schemas/member"
+
    1
+2
+3
+4
+5
+6
+7
+8
    {
+    "status": "accepted",
+    "created_at": "2016-09-01T02:05:14Z",
+    "updated_at": "2016-09-01T02:37:11Z",
+    "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+    "member_id": "edc89b490d7d4392898e19b2deb34797",
+    "schema": "/v2/schemas/member"
 }
-
    
-
    
+
    + +

    • Returned Values

  • Example response
    STATUS CODE 200
    -
    1
-2
-3
-4
-5
-6
-7
-8
    {
-    "status": "accepted",
-    "created_at": "2016-09-01T02:05:14Z",
-    "updated_at": "2016-09-01T02:37:11Z",
-    "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-    "member_id": "edc89b490d7d4392898e19b2deb34797",
-    "schema": "/v2/schemas/member"
+
    1
+2
+3
+4
+5
+6
+7
+8
    {
+    "status": "accepted",
+    "created_at": "2016-09-01T02:05:14Z",
+    "updated_at": "2016-09-01T02:37:11Z",
+    "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+    "member_id": "edc89b490d7d4392898e19b2deb34797",
+    "schema": "/v2/schemas/member"
 }
-
    
-
    
+
    + +

    • Returned Values

  • Example response
    STATUS CODE 200
    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
    {
-    "members": [
-        {
-            "status": "accepted",
-            "created_at": "2016-09-01T02:05:14Z",
-            "updated_at": "2016-09-01T02:37:11Z",
-            "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-            "member_id": "edc89b490d7d4392898e19b2deb34797",
-            "schema": "/v2/schemas/member"
-        }
-    ],
-    "schema": "/v2/schemas/members"
+
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
    {
+    "members": [
+        {
+            "status": "accepted",
+            "created_at": "2016-09-01T02:05:14Z",
+            "updated_at": "2016-09-01T02:37:11Z",
+            "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+            "member_id": "edc89b490d7d4392898e19b2deb34797",
+            "schema": "/v2/schemas/member"
+        }
+    ],
+    "schema": "/v2/schemas/members"
 }
-
    
-
    
+
    + +

    • Returned Values

    Example Request

    Adding tenants who can use shared images (image IDs: d164b5df-1bc3-4c3f-893e-3e471fd16e64, 0b680482-acaa-4045-b14c-9a8c7dfe9c70; project IDs: 9c61004714024f9586705d090530f9fa, edc89b490d7d4392898e19b2deb34797)

    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
    POST https://{Endpoint}/v1/cloudimages/members
+
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
    POST https://{Endpoint}/v1/cloudimages/members
 {
-    "images": [
-        "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-        "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
-    ],
-    "projects": [
-        "9c61004714024f9586705d090530f9fa",
-        "edc89b490d7d4392898e19b2deb34797"
-    ]
+    "images": [
+        "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+        "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
+    ],
+    "projects": [
+        "9c61004714024f9586705d090530f9fa",
+        "edc89b490d7d4392898e19b2deb34797"
+    ]
 }
-
    
-
    
+
    + +

    Response

    Returned Values

    -

    Example Request

    Response

  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
    1
+2
+3
    {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
    
-
    
+
    + +

    • Returned Values

    Example Request

    Deleting image recipients who can use shared images (image IDs: d164b5df-1bc3-4c3f-893e-3e471fd16e64, 0b680482-acaa-4045-b14c-9a8c7dfe9c70; project IDs: 9c61004714024f9586705d090530f9fa, edc89b490d7d4392898e19b2deb34797)

    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
    DELETE https://{Endpoint}/v1/cloudimages/members
+
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
    DELETE https://{Endpoint}/v1/cloudimages/members
 {
-  "images": [
-        "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-        "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
-  ],
-  "projects": [
-        "9c61004714024f9586705d090530f9fa",
-        "edc89b490d7d4392898e19b2deb34797"
-    ]
+  "images": [
+        "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+        "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
+  ],
+  "projects": [
+        "9c61004714024f9586705d090530f9fa",
+        "edc89b490d7d4392898e19b2deb34797"
+    ]
 }
-
    
-
    
+
    + +

    Response

    Returned Values

    Example Request

    Registering an image (URL of the image file: bucketname:Centos6.5-disk1.vmdk)

    -
    1
-2
-3
-4
    PUT https://{Endpoint}/v1/cloudimages/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86/upload
+
    1
+2
+3
+4
    PUT https://{Endpoint}/v1/cloudimages/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba86/upload
 {
-   "image_url": "bucketname:Centos6.5-disk1.vmdk" 
+   "image_url": "bucketname:Centos6.5-disk1.vmdk" 
 }
-
    
-
    
+
    + +

    Response

    Returned Values

    Example Request

    Replicating an image (name: ims_encrypted_copy3) within a region

    -
    1
-2
-3
-4
-5
-6
    POST https://{Endpoint}/v1/cloudimages/465076de-dc36-4aec-80f5-ef9d8009428f/copy
+
    1
+2
+3
+4
+5
+6
    POST https://{Endpoint}/v1/cloudimages/465076de-dc36-4aec-80f5-ef9d8009428f/copy
 {
-    "name": "ims_encrypted_copy3",
-    "description": "test copy",
-    "cmk_id": "bd66288c-9081-460a-8227-4cbd0c814cb4"
+    "name": "ims_encrypted_copy3",
+    "description": "test copy",
+    "cmk_id": "bd66288c-9081-460a-8227-4cbd0c814cb4"
 }
-
    
-
    
+
    + +

    Response

    Returned Values

  • 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
    {
-    "name": "member",
-    "properties": {
-        "status": {
-            "enum": [
-                "pending",
-                "accepted",
-                "rejected"
-            ],
-            "type": "string",
-            "description": "The status of this image member"
-        },
-        "created_at": {
-            "type": "string",
-            "description": "Date and time of image member creation"
-        },
-        "updated_at": {
-            "type": "string",
-            "description": "Date and time of last modification of image member"
-        },
-        "image_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"
-        },
-        "member_id": {
-            "type": "string",
-            "description": "An identifier for the image member (tenantId)"
-        },
-        "schema": {
-            "readOnly": true,
-            "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
    {
+    "name": "member",
+    "properties": {
+        "status": {
+            "enum": [
+                "pending",
+                "accepted",
+                "rejected"
+            ],
+            "type": "string",
+            "description": "The status of this image member"
+        },
+        "created_at": {
+            "type": "string",
+            "description": "Date and time of image member creation"
+        },
+        "updated_at": {
+            "type": "string",
+            "description": "Date and time of last modification of image member"
+        },
+        "image_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"
+        },
+        "member_id": {
+            "type": "string",
+            "description": "An identifier for the image member (tenantId)"
+        },
+        "schema": {
+            "readOnly": true,
+            "type": "string"
+        }
+    }
 }
-
    
-
    
+
    + +

    • Returned Values

  • 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
    {
-    "name": "members",
-    "links": [
-        {
-            "href": "{schema}",
-            "rel": "describedby"
-        }
-    ],
-    "properties": {
-        "members": {
-            "items": {
-                "name": "member",
-                "properties": {
-                    "status": {
-                        "enum": [
-                            "pending",
-                            "accepted",
-                            "rejected"
-                        ],
-                        "type": "string",
-                        "description": "The status of this image member"
-                    },
-                    "created_at": {
-                        "type": "string",
-                        "description": "Date and time of image member creation"
-                    },
-                    "updated_at": {
-                        "type": "string",
-                        "description": "Date and time of last modification of image member"
-                    },
-                    "image_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"
-                    },
-                    "member_id": {
-                        "type": "string",
-                        "description": "An identifier for the image member (tenantId)"
-                    },
-                    "schema": {
-                        "readOnly": true,
-                        "type": "string"
-                    }
-                }
-            },
-            "type": "array"
-        },
-        "schema": {
-            "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
    {
+    "name": "members",
+    "links": [
+        {
+            "href": "{schema}",
+            "rel": "describedby"
+        }
+    ],
+    "properties": {
+        "members": {
+            "items": {
+                "name": "member",
+                "properties": {
+                    "status": {
+                        "enum": [
+                            "pending",
+                            "accepted",
+                            "rejected"
+                        ],
+                        "type": "string",
+                        "description": "The status of this image member"
+                    },
+                    "created_at": {
+                        "type": "string",
+                        "description": "Date and time of image member creation"
+                    },
+                    "updated_at": {
+                        "type": "string",
+                        "description": "Date and time of last modification of image member"
+                    },
+                    "image_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"
+                    },
+                    "member_id": {
+                        "type": "string",
+                        "description": "An identifier for the image member (tenantId)"
+                    },
+                    "schema": {
+                        "readOnly": true,
+                        "type": "string"
+                    }
+                }
+            },
+            "type": "array"
+        },
+        "schema": {
+            "type": "string"
+        }
+    }
 }
-
    
-
    
+
    + +

    • Returned Values

    Response

    Returned Values

  • Example response
    STATUS CODE 200
    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
    {
-  "quotas": {
-    "resources": [
-      {
-        "type": "image",
-        "used": 0,
-        "quota": 20,
-        "min": 1,
-        "max": 1000
-      }
-    ]
-  }
+
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
    {
+  "quotas": {
+    "resources": [
+      {
+        "type": "image",
+        "used": 0,
+        "quota": 20,
+        "min": 1,
+        "max": 1000
+      }
+    ]
+  }
 }
-
    
-
    
+
    + +

    • Returned Values

    -

    Example Request

    -

    Response

    diff --git a/docs/ims/api-ref/en-us_topic_0102682862.html b/docs/ims/api-ref/en-us_topic_0102682862.html index 67260503..754ba9d2 100644 --- a/docs/ims/api-ref/en-us_topic_0102682862.html +++ b/docs/ims/api-ref/en-us_topic_0102682862.html @@ -110,72 +110,74 @@ -

    Example Request

    Response

    Example Request

    Adding an image tag (key1:value1)

    -
    1
-2
-3
-4
-5
-6
-7
    POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags
+
    1
+2
+3
+4
+5
+6
+7
    POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags
 {
-   "tag": {
-      "value": "value1",
-      "key": "key1"
-   }
+   "tag": {
+      "value": "value1",
+      "key": "key1"
+   }
 }
-
    
-
    
+
    + +

    Response

  • Example response
    STATUS CODE 200
    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
    {
-   "tags": [{
-      "value": "value0",
-      "key": "key0"
-   },
-   {
-      "value": "value0",
-      "key": "key1"
-   }]
+
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
    {
+   "tags": [{
+      "value": "value0",
+      "key": "key0"
+   },
+   {
+      "value": "value0",
+      "key": "key1"
+   }]
 }
-
    
-
    
+
    + +

    • Returned Values

  • Example response
    STATUS CODE 200
    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
    {
-   "tags": [{
-      "values": ["value9"],
-      "key": "key9"
-   },
-   {
-      "values": [""],
-      "key": "key8"
-   },
-   {
-      "values": 
-        ["valueXX",
-        "value3"],
-      "key": "key3"
-   }]
+
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
    {
+   "tags": [{
+      "values": ["value9"],
+      "key": "key9"
+   },
+   {
+      "values": [""],
+      "key": "key8"
+   },
+   {
+      "values": 
+        ["valueXX",
+        "value3"],
+      "key": "key3"
+   }]
 }
-
    
-
    
+
    + +

    • Returned Values

    -

    Constraints

    Before importing image files, ensure that the file format is RAW or ZVHD2 and the following have been done: +

    Constraints

    Before importing image files, ensure that the file format is RAW or ZVHD2 and the following have been done:
    • RAW image files have been optimized, and bitmap files have been generated.
    • ZVHD2 image files have been optimized as required.

    For how to convert image file formats and generate a bitmap file, see section "Quickly Importing an Image File" in the Image Management Service User Guide.

    @@ -179,7 +179,7 @@

    Specifies the URL of the external image file in the OBS bucket.

    This parameter is mandatory if an external image file in the OBS bucket is used to create an image. The format is OBS bucket name:Image file name.

    -
    NOTE:

    The storage class of the OBS bucket must be Standard.

    +
    NOTE:

    The storage class of the OBS bucket must be Standard.

    @@ -220,6 +220,7 @@

    String

    Specifies the image type. The parameter value is DataImage for data disk images.

    +

    enterprise_project_id

    @@ -229,7 +230,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.

      @@ -238,108 +239,112 @@
    -

    Example Request

    • Creating a system disk image with parameter tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
       1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
      POST https://{Endpoint}/v2/cloudimages/quickimport/action
-{  
-    "name": "ims_test_file",  
-   "description": "Create an image using a file in the OBS bucket.", 
-    "image_url": "ims-image:centos70.zvhd2",  
-    "os_version": "CentOS 7.0 64bit",  
-    "min_disk": 40,  
-    "type": "ECS", 
-    "tags":
-        [
-            "aaa.111",    
-            "bbb.333",    
-            "ccc.444"    
-        ]
+
      Example Request
      • Creating a system disk image with parameter tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
        POST https://{Endpoint}/v2/cloudimages/quickimport/action
+{  
+    "name": "ims_test_file",  
+   "description": "Create an image using a file in the OBS bucket.", 
+    "image_url": "ims-image:centos70.zvhd2",  
+    "os_version": "CentOS 7.0 64bit",  
+    "min_disk": 40,  
+    "type": "ECS", 
+    "tags":
+        [
+            "aaa.111",    
+            "bbb.333",    
+            "ccc.444"    
+        ]
 }
-
        
-
        
-
      • Creating a system disk image with parameter image_tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
        POST https://{Endpoint}/v2/cloudimages/quickimport/action
-{  
-    "name": "ims_test_file",  
-   "description": "Create an image using a file in the OBS bucket.", 
-    "image_url": "ims-image:centos70.zvhd2",  
-    "os_version": "CentOS 7.0 64bit",  
-    "min_disk": 40,  
-    "type": "ECS", 
-    "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]  
+
        
+
+
      
+
    • Creating a system disk image with parameter image_tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
       1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
      POST https://{Endpoint}/v2/cloudimages/quickimport/action
+{  
+    "name": "ims_test_file",  
+   "description": "Create an image using a file in the OBS bucket.", 
+    "image_url": "ims-image:centos70.zvhd2",  
+    "os_version": "CentOS 7.0 64bit",  
+    "min_disk": 40,  
+    "type": "ECS", 
+    "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]  
 }
-
      
-
      
-
    • Creating a data disk image with parameter tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
       1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
      POST https://{Endpoint}/v2/cloudimages/quickimport/action
-{  
-    "name": "ims_test_file",  
-   "description": "Create an image using a file in the OBS bucket.", 
-    "image_url": "ims-image:centos70.zvhd2",  
-    "os_type": "Linux",  
-    "min_disk": 40,  
-    "type": "DataImage",  
-    "tags": [    
-        "aaa.111",    
-        "bbb.333",    
-        "ccc.444"    
-    ]
+
      
+
+
      • +
    • Creating a data disk image with parameter tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
       1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
      POST https://{Endpoint}/v2/cloudimages/quickimport/action
+{  
+    "name": "ims_test_file",  
+   "description": "Create an image using a file in the OBS bucket.", 
+    "image_url": "ims-image:centos70.zvhd2",  
+    "os_type": "Linux",  
+    "min_disk": 40,  
+    "type": "DataImage",  
+    "tags": [    
+        "aaa.111",    
+        "bbb.333",    
+        "ccc.444"    
+    ]
 }
-
      -
      -
    • Creating a data disk image with parameter image_tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
       1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
      POST https://{Endpoint}/v2/cloudimages/quickimport/action
-{  
-    "name": "ims_test_file",  
-   "description": "Create an image using a file in the OBS bucket.", 
-    "image_url": "ims-image:centos70.zvhd2",  
-    "os_type": "Linux",  
-    "min_disk": 40,  
-    "type": "DataImage",
-    "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
+
      + + +
    • Creating a data disk image with parameter image_tags using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)
       1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
      POST https://{Endpoint}/v2/cloudimages/quickimport/action
+{  
+    "name": "ims_test_file",  
+   "description": "Create an image using a file in the OBS bucket.", 
+    "image_url": "ims-image:centos70.zvhd2",  
+    "os_type": "Linux",  
+    "min_disk": 40,  
+    "type": "DataImage",
+    "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
 }
-
      -
      +
      • + +

    Response

    • Response parameters @@ -363,13 +368,14 @@
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-     "job_id": "8a12fc664fb4daa3014fb4e581380005"
+
    1
+2
+3
    {
+     "job_id": "8a12fc664fb4daa3014fb4e581380005"
 }
-
    
-
    
+
    + +

    • Returned Values

  • Example response
    STATUS CODE 300
    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
    {
-    "versions": [
-        {
-            "status": "SUPPORTED",
-            "id": "v2.0",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v2/",
-                    "rel": "self"
-                }
-            ]
-        }
-    ]
+
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
    {
+    "versions": [
+        {
+            "status": "SUPPORTED",
+            "id": "v2.0",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v2/",
+                    "rel": "self"
+                }
+            ]
+        }
+    ]
 }
-
    
-
    
+
    + +

    • Returned Values