From c2364787346789b888239a6c88e3cb18edb0a5c5 Mon Sep 17 00:00:00 2001 From: "Zaoxu, Li" Date: Wed, 5 Jun 2024 07:22:50 +0000 Subject: [PATCH] IMS API DOC Reviewed-by: Pristromskaia, Margarita Co-authored-by: Zaoxu, Li Co-committed-by: Zaoxu, Li --- docs/ims/api-ref/en-us_topic_0020091555.html | 773 ++++++++-------- docs/ims/api-ref/en-us_topic_0020091556.html | 897 ++++++++++--------- docs/ims/api-ref/en-us_topic_0020091562.html | 12 +- docs/ims/api-ref/en-us_topic_0020091565.html | 317 +++---- docs/ims/api-ref/en-us_topic_0020091566.html | 137 +-- docs/ims/api-ref/en-us_topic_0020091567.html | 200 +++-- docs/ims/api-ref/en-us_topic_0020092108.html | 15 +- docs/ims/api-ref/en-us_topic_0020092109.html | 289 +++--- docs/ims/api-ref/en-us_topic_0022473688.html | 85 +- docs/ims/api-ref/en-us_topic_0022473689.html | 35 +- docs/ims/api-ref/en-us_topic_0024735403.html | 16 +- docs/ims/api-ref/en-us_topic_0031615565.html | 12 +- docs/ims/api-ref/en-us_topic_0036994315.html | 38 +- docs/ims/api-ref/en-us_topic_0036994317.html | 48 +- docs/ims/api-ref/en-us_topic_0036994318.html | 67 +- docs/ims/api-ref/en-us_topic_0036994319.html | 33 +- docs/ims/api-ref/en-us_topic_0036994320.html | 53 +- docs/ims/api-ref/en-us_topic_0036994322.html | 56 +- docs/ims/api-ref/en-us_topic_0036994323.html | 87 +- docs/ims/api-ref/en-us_topic_0036994324.html | 56 +- docs/ims/api-ref/en-us_topic_0037131984.html | 30 +- docs/ims/api-ref/en-us_topic_0049147856.html | 36 +- docs/ims/api-ref/en-us_topic_0049147876.html | 141 +-- docs/ims/api-ref/en-us_topic_0049147877.html | 209 ++--- docs/ims/api-ref/en-us_topic_0060804959.html | 333 +++---- docs/ims/api-ref/en-us_topic_0060804960.html | 229 ++--- docs/ims/api-ref/en-us_topic_0066978719.html | 217 ++--- docs/ims/api-ref/en-us_topic_0066978720.html | 115 +-- docs/ims/api-ref/en-us_topic_0066978721.html | 83 +- docs/ims/api-ref/en-us_topic_0066978722.html | 19 +- docs/ims/api-ref/en-us_topic_0067360381.html | 38 +- docs/ims/api-ref/en-us_topic_0067360382.html | 39 +- docs/ims/api-ref/en-us_topic_0083905788.html | 97 +- docs/ims/api-ref/en-us_topic_0092380109.html | 179 ++-- docs/ims/api-ref/en-us_topic_0093967372.html | 53 +- docs/ims/api-ref/en-us_topic_0102682861.html | 428 ++++----- docs/ims/api-ref/en-us_topic_0102682862.html | 126 +-- docs/ims/api-ref/en-us_topic_0102682863.html | 27 +- docs/ims/api-ref/en-us_topic_0102682865.html | 41 +- docs/ims/api-ref/en-us_topic_0102682866.html | 65 +- docs/ims/api-ref/en-us_topic_0133188204.html | 220 ++--- docs/ims/api-ref/en-us_topic_0170918588.html | 57 +- docs/ims/api-ref/test1703560485403.txt | 1 - 43 files changed, 3044 insertions(+), 2965 deletions(-) delete mode 100644 docs/ims/api-ref/test1703560485403.txt 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

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0020091556.html b/docs/ims/api-ref/en-us_topic_0020091556.html index a474f6df..b0a6b201 100644 --- a/docs/ims/api-ref/en-us_topic_0020091556.html +++ b/docs/ims/api-ref/en-us_topic_0020091556.html @@ -73,455 +73,456 @@
  • 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

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0020091562.html b/docs/ims/api-ref/en-us_topic_0020091562.html index 0d01df4e..f3ba634d 100644 --- a/docs/ims/api-ref/en-us_topic_0020091562.html +++ b/docs/ims/api-ref/en-us_topic_0020091562.html @@ -152,7 +152,7 @@

      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

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

      +

      This attribute cannot co-exist with __support_xen.

      __support_kvm_infiniband

      @@ -335,7 +335,7 @@

      String

      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.

      +

      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 02b6e2a6..26cc5bbc 100644 --- a/docs/ims/api-ref/en-us_topic_0020091565.html +++ b/docs/ims/api-ref/en-us_topic_0020091565.html @@ -127,7 +127,7 @@

      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.

      min_ram

      @@ -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.

      @@ -267,7 +267,7 @@

      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

      @@ -314,7 +314,7 @@

      String

      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.

      +

      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.

      @@ -459,7 +459,7 @@

      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.
      +
      • 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

      @@ -551,7 +551,7 @@

      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

      @@ -602,7 +602,7 @@

      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.
      +
      • Public image: The value is gold.
      • Private image: The value is private.
      • Shared image: The value is shared.

      created_at

      @@ -674,42 +674,42 @@

      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

      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

      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

      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

      @@ -717,23 +717,23 @@

      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.

      +

      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

      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

      String

      -

      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.

      +

      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

      @@ -803,143 +803,144 @@
  • 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

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0020091566.html b/docs/ims/api-ref/en-us_topic_0020091566.html index a0fafc2b..087739db 100644 --- a/docs/ims/api-ref/en-us_topic_0020091566.html +++ b/docs/ims/api-ref/en-us_topic_0020091566.html @@ -183,7 +183,7 @@

      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

      @@ -350,14 +350,14 @@

      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

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

      +

      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

      @@ -380,7 +380,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

      @@ -388,7 +388,7 @@

      String

      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.

      +

      This attribute cannot co-exist with __support_xen.

      __support_fc_inject

      @@ -436,81 +436,82 @@

      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

      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

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0020091567.html b/docs/ims/api-ref/en-us_topic_0020091567.html index 578e03ce..a392d878 100644 --- a/docs/ims/api-ref/en-us_topic_0020091567.html +++ b/docs/ims/api-ref/en-us_topic_0020091567.html @@ -102,23 +102,24 @@

    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

    • Response parameters
      - - @@ -450,14 +451,14 @@ - - -

      Parameter

      @@ -268,7 +269,7 @@

      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

      @@ -441,7 +442,7 @@

      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.

      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

      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

      @@ -472,7 +473,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.

      +

      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

      @@ -480,7 +481,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

      @@ -488,7 +489,7 @@

      String

      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.

      +

      This attribute cannot co-exist with __support_xen.

      enterprise_project_id

      @@ -522,90 +523,91 @@

      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

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0020092108.html b/docs/ims/api-ref/en-us_topic_0020092108.html index ef6d91cb..665e1f43 100644 --- a/docs/ims/api-ref/en-us_topic_0020092108.html +++ b/docs/ims/api-ref/en-us_topic_0020092108.html @@ -56,15 +56,16 @@

    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

    • Response parameters

      None

    • Example response
      STATUS CODE 204
      diff --git a/docs/ims/api-ref/en-us_topic_0020092109.html b/docs/ims/api-ref/en-us_topic_0020092109.html index c4d1e481..000e1b3a 100644 --- a/docs/ims/api-ref/en-us_topic_0020092109.html +++ b/docs/ims/api-ref/en-us_topic_0020092109.html @@ -6,7 +6,7 @@

      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.

    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.

    • ECS and FusionCompute: indicate an ECS image.
    • BMS and Ironic: indicate a BMS image.
    • IsoImage: indicates an image created using an ISO file.
    @@ -301,7 +301,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.

      @@ -320,7 +320,7 @@

      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

      @@ -429,7 +429,7 @@

      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

      @@ -537,7 +537,7 @@

      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

      @@ -547,7 +547,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

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

        @@ -577,58 +577,60 @@ "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
+
      • 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"
-              ]
-       }]
+       "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 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
+
        
+
+
        • +
      • 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"  
-      ]     
+      "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"  
+      ]     
 }
-
        -
        +
        • + +
    • Creating a system disk image with parameter image_tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
      POST https://{Endpoint}/v2/cloudimages/action
 {
@@ -646,88 +648,92 @@
 }
          ]
 }
      -
    • 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
+
    • 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"}]
-       }]
+       "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 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
+
      
+
+
      • +
    • 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"}]    
+       "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"}]    
 }
-
      -
      -
    • 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
+
      + + +
    • 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",
+        "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"}] 
- } 
-
      -
      + "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 @@ -751,13 +757,14 @@
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "8a12fc664fb4daa3014fb4e581380005"
+
    1
+2
+3
    {
+    "job_id": "8a12fc664fb4daa3014fb4e581380005"
 }
-
    
-
    
+
    + +

    • Returned Values

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0022473688.html b/docs/ims/api-ref/en-us_topic_0022473688.html index 67f35eb6..647adcf6 100644 --- a/docs/ims/api-ref/en-us_topic_0022473688.html +++ b/docs/ims/api-ref/en-us_topic_0022473688.html @@ -302,49 +302,50 @@
    • 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
      {
-    "status": "SUCCESS",
-    "entities": {
-        "image_id": "e9e91bff-14b6-4a0b-8377-4ed0813e3360",
-        "image_name": "asdfasdfasdfas",
-        "process_percent": 0.20,
-        "current_task": "CreateImageByInstanceTask",
-        "results": [{
-                "image_id": "49e9447f-7dff-41e0-8036-f66fe5488c8b",
-                "project_id": "089b2f9a3d80d3062f24c00ca4ed5cbd",
-                "status": "success"
-            }
-        ]
-    },
-    "job_id": "ff8080814dbd65d7014dbe0d84db0013",
-    "job_type": "createImageByInstance",
-    "begin_time": "04-Jun-2015 18:11:06:586",
-    "end_time": "",
-    "error_code": null,
-    "fail_reason": null
+
       1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
      {
+    "status": "SUCCESS",
+    "entities": {
+        "image_id": "e9e91bff-14b6-4a0b-8377-4ed0813e3360",
+        "image_name": "asdfasdfasdfas",
+        "process_percent": 0.20,
+        "current_task": "CreateImageByInstanceTask",
+        "results": [{
+                "image_id": "49e9447f-7dff-41e0-8036-f66fe5488c8b",
+                "project_id": "089b2f9a3d80d3062f24c00ca4ed5cbd",
+                "status": "success"
+            }
+        ]
+    },
+    "job_id": "ff8080814dbd65d7014dbe0d84db0013",
+    "job_type": "createImageByInstance",
+    "begin_time": "04-Jun-2015 18:11:06:586",
+    "end_time": "",
+    "error_code": null,
+    "fail_reason": null
 }
-
      
-
      
+
      + +

    Returned Values

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0022473689.html b/docs/ims/api-ref/en-us_topic_0022473689.html index 076261d0..6c15a6a3 100644 --- a/docs/ims/api-ref/en-us_topic_0022473689.html +++ b/docs/ims/api-ref/en-us_topic_0022473689.html @@ -4,19 +4,20 @@

      Function Description

      If the returned status code is 400, a customized error message will be returned. This section describes the meaning of each status code.

      Response Format

      STATUS CODE 400
      -
      1
-2
-3
-4
-5
-6
      {
-    "error": {
-        "message": "The imagetype is invalid.",
-        "code": "IMG.0024"
-    }
+
      1
+2
+3
+4
+5
+6
      {
+    "error": {
+        "message": "The imagetype is invalid.",
+        "code": "IMG.0024"
+    }
 }
-
      
-
      
+
      + +

      Error Message Description

      - @@ -422,7 +423,7 @@ - @@ -1402,7 +1403,7 @@ - @@ -1919,9 +1920,9 @@ - - - + + + @@ -98,7 +104,7 @@ - @@ -233,7 +239,7 @@ - diff --git a/docs/ims/api-ref/en-us_topic_0031615565.html b/docs/ims/api-ref/en-us_topic_0031615565.html index 2935c08d..cb432113 100644 --- a/docs/ims/api-ref/en-us_topic_0031615565.html +++ b/docs/ims/api-ref/en-us_topic_0031615565.html @@ -52,7 +52,7 @@ - - - @@ -82,19 +82,20 @@ -

      Example Request

      Table 1 Error codes

      Status Code

      @@ -147,7 +148,7 @@

      forceCreate must be set to true.

      forceCreate must be set to true.

      +

      forceCreate must be set to true.

      Set forceCreate to true.

      An error occurred when the value of asumeToken was obtained.

      An error occurred when the value of asumeToken was obtained.

      +

      An error occurred when the value of asumeToken was obtained.

      Contact technical support.

      The value of hw_firmware_type is not uefi or bios.

      The value of hw_firmware_type is not uefi or bios.

      +

      The value of hw_firmware_type is not uefi or bios.

      Set hw_firmware_type to uefi or bios.

      The value of Architecture must be x86 or Arm.

      The value of Architecture must be x86 or Arm.

      +

      The value of Architecture must be x86 or Arm.

      Set Architecture to x86 or arm.

      +

      Set Architecture to x86 or arm.

      400

      diff --git a/docs/ims/api-ref/en-us_topic_0024735403.html b/docs/ims/api-ref/en-us_topic_0024735403.html index 304be371..dfdc0642 100644 --- a/docs/ims/api-ref/en-us_topic_0024735403.html +++ b/docs/ims/api-ref/en-us_topic_0024735403.html @@ -8,7 +8,13 @@

      2024-01-15

      +

      2024-05-27

      +

      Modified the following content:

      +

      Added the image format description of the is_quick_export parameter for quickly exporting images in Exporting an Image.

      +

      2024-01-15

      Modified the following content:

      Added a description for os_version and the value IsoImage for type in Creating an Image.

      @@ -67,7 +73,7 @@

      2020-08-12

      Modified the following content:

      -
      A CBR backup can be used to create a full-ECS image. The following changes are involved: +
      A CBR backup can be used to create a full-ECS image. The following changes are involved:

      2019-01-30

      Modified the following content:

      - +

      2018-09-30

      @@ -211,7 +217,7 @@

      2017-02-08

      Modified the following content:
      • Updated the values of __os_version.
      +
      Modified the following content:
      • Updated the values of __os_version.

      2016-10-29

      Added the following content: +
      Added the following content:

      Boolean

      Specifies whether the image is protected. A protected image cannot be deleted. The default value is false.

      +

      Specifies whether the image is protected. A protected image cannot be deleted. The default value is false.

      container_format

      @@ -62,7 +62,7 @@

      String

      Specifies the container format.

      -

      The default value is bare.

      +

      The default value is bare.

      disk_format

      @@ -92,7 +92,7 @@

      Integer

      Specifies the minimum memory size (MB) required for running the image. The parameter value depends on ECS specifications. The default value is 0.

      +

      Specifies the minimum memory size (MB) required for running the image. The parameter value depends on ECS specifications. The default value is 0.

      min_disk

      @@ -161,7 +161,7 @@

      String

      Specifies the container format.

      -

      The value is bare.

      +

      The value is bare.

      disk_format

      @@ -260,7 +260,7 @@

      String

      Specifies whether the image is registered. Only registered images can be queried on the portal. The value is true.

      +

      Specifies whether the image is registered. Only registered images can be queried on the portal. The value is true.

      __os_version

      @@ -304,7 +304,7 @@

      Specifies the platform type.

      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 an ECS data disk image, the value is DataImage.
      • For a BMS image, the value is Ironic.
      • For an ISO image, the value is IsoImage.
      +
      • For an ECS image, the value is FusionCompute.
      • For an ECS data disk image, the value is DataImage.
      • For a BMS image, the value is Ironic.
      • For an ISO image, the value is IsoImage.

      owner

      diff --git a/docs/ims/api-ref/en-us_topic_0036994315.html b/docs/ims/api-ref/en-us_topic_0036994315.html index 6fe0f031..c72144e0 100644 --- a/docs/ims/api-ref/en-us_topic_0036994315.html +++ b/docs/ims/api-ref/en-us_topic_0036994315.html @@ -73,7 +73,7 @@

      Boolean

      Whether to enable fast export. The value can be true or false.

      -
      NOTE:

      If fast export is enabled, file_format cannot be specified.

      +
      NOTE:

      If fast export is enabled, file_format cannot be specified. The exported image file is in the ZVHD2 format.

      		 
      1
-2
-3
-4
-5
-6
      POST https://{Endpoint}/v1/cloudimages/d164b5df-1bc3-4c3f-893e-3e471fd16e64/file
+
      Example Request
      1
+2
+3
+4
+5
+6
      POST https://{Endpoint}/v1/cloudimages/d164b5df-1bc3-4c3f-893e-3e471fd16e64/file
 {
-   "bucket_url": "ims-image:centos7_5.qcow2",
-   "file_format": "qcow2",
-   "is_quick_export": false
+   "bucket_url": "ims-image:centos7_5.qcow2",
+   "file_format": "qcow2",
+   "is_quick_export": false
 }
-
      
-
      
+
      + +

    Response

    • Response parameters

      Parameter

      @@ -117,13 +118,14 @@
    • Example response
      STATUS CODE 200
      -
      1
-2
-3
      {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
      1
+2
+3
      {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
      
-
      
+
      + +

    Returned Values

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0036994317.html b/docs/ims/api-ref/en-us_topic_0036994317.html index c126bfa3..24ee129b 100644 --- a/docs/ims/api-ref/en-us_topic_0036994317.html +++ b/docs/ims/api-ref/en-us_topic_0036994317.html @@ -34,15 +34,16 @@

    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

    • Response parameters

      Parameter

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

    Returned Values

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0036994318.html b/docs/ims/api-ref/en-us_topic_0036994318.html index 6de82fe9..858e1ae3 100644 --- a/docs/ims/api-ref/en-us_topic_0036994318.html +++ b/docs/ims/api-ref/en-us_topic_0036994318.html @@ -76,26 +76,28 @@
    -

    Example Request

    • Updating the image sharing status to accepted
      1
-2
-3
-4
      PUT https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797
+
      Example Request
      • Updating the image sharing status to accepted
        1
+2
+3
+4
        PUT https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797
 {
-    "status": "accepted"
+    "status": "accepted"
 }
-
        
-
        
-
      • Updating the sharing status of an image created from a CBR backup to accepted (vault ID: 6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61)
        1
-2
-3
-4
-5
        PUT https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797
+
        
+
+
      
+
    • Updating the sharing status of an image created from a CBR backup to accepted (vault ID: 6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61)
      1
+2
+3
+4
+5
      PUT https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797
 {
-    "status": "accepted",
-    "vault_id": "6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61"
+    "status": "accepted",
+    "vault_id": "6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61"
 }
-
      
-
      
+
      • + +

    Response

    • Response parameters @@ -153,23 +155,24 @@
  • 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

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0036994319.html b/docs/ims/api-ref/en-us_topic_0036994319.html index 20386dbe..6dca6fef 100644 --- a/docs/ims/api-ref/en-us_topic_0036994319.html +++ b/docs/ims/api-ref/en-us_topic_0036994319.html @@ -99,23 +99,24 @@
  • 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

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0036994320.html b/docs/ims/api-ref/en-us_topic_0036994320.html index b8deea42..ba7c7c46 100644 --- a/docs/ims/api-ref/en-us_topic_0036994320.html +++ b/docs/ims/api-ref/en-us_topic_0036994320.html @@ -117,33 +117,34 @@
  • 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

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0036994322.html b/docs/ims/api-ref/en-us_topic_0036994322.html index 228a1dfb..952e7857 100644 --- a/docs/ims/api-ref/en-us_topic_0036994322.html +++ b/docs/ims/api-ref/en-us_topic_0036994322.html @@ -43,29 +43,30 @@

    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

    • Response parameters

      Parameter

      @@ -88,13 +89,14 @@
    • Example response
      STATUS CODE 200
      -
      1
-2
-3
      {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
      1
+2
+3
      {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
      
-
      
+
      + +

    Returned Values

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0036994323.html b/docs/ims/api-ref/en-us_topic_0036994323.html index bfeb232e..cc13e907 100644 --- a/docs/ims/api-ref/en-us_topic_0036994323.html +++ b/docs/ims/api-ref/en-us_topic_0036994323.html @@ -62,46 +62,48 @@
    -

    Example Request

    • Updating the image sharing status to accepted in batches
      1
-2
-3
-4
-5
-6
-7
-8
-9
      PUT https://{Endpoint}/v1/cloudimages/members
+
      Example Request
      • Updating the image sharing status to accepted in batches
        1
+2
+3
+4
+5
+6
+7
+8
+9
        PUT https://{Endpoint}/v1/cloudimages/members
 {
-   "images": [
-          "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-          "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
-      ],
-      "project_id": "edc89b490d7d4392898e19b2deb34797",
-      "status": "accepted"
+   "images": [
+          "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+          "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
+      ],
+      "project_id": "edc89b490d7d4392898e19b2deb34797",
+      "status": "accepted"
 }
-
        
-
        
-
      • Updating the sharing status of images created from CBR backups to accepted in batches (vault ID: d14r5tef-1bc3-4c4f-823e-3e471rg65e65)
         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
        PUT https://{Endpoint}/v1/cloudimages/members
+
        
+
+
      
+
    • Updating the sharing status of images created from CBR backups to accepted in batches (vault ID: d14r5tef-1bc3-4c4f-823e-3e471rg65e65)
       1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
      PUT https://{Endpoint}/v1/cloudimages/members
 {
-   "images": [
-          "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
-          "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
-      ],
-      "project_id": "edc89b490d7d4392898e19b2deb34797",
-      "status": "accepted",
-      "vault_id": "d14r5tef-1bc3-4c4f-823e-3e471rg65e65"
+   "images": [
+          "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
+          "0b680482-acaa-4045-b14c-9a8c7dfe9c70"
+      ],
+      "project_id": "edc89b490d7d4392898e19b2deb34797",
+      "status": "accepted",
+      "vault_id": "d14r5tef-1bc3-4c4f-823e-3e471rg65e65"
 }
-
      
-
      
+
      • + +

    Response

    • Response parameters @@ -125,13 +127,14 @@
  • Example response
    STATUS CODE 200
    -
    1
-2
-3
    {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
    1
+2
+3
    {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
    
-
    
+
    + +

    • Returned Values

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0036994324.html b/docs/ims/api-ref/en-us_topic_0036994324.html index fe88d2ef..f664fa47 100644 --- a/docs/ims/api-ref/en-us_topic_0036994324.html +++ b/docs/ims/api-ref/en-us_topic_0036994324.html @@ -41,29 +41,30 @@

    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

    • Response parameters

      Parameter

      @@ -86,13 +87,14 @@
    • Example response
      STATUS CODE 200
      -
      1
-2
-3
      {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
      1
+2
+3
      {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
      
-
      
+
      + +

    Returned Values

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0037131984.html b/docs/ims/api-ref/en-us_topic_0037131984.html index df8c8255..2c406ffb 100644 --- a/docs/ims/api-ref/en-us_topic_0037131984.html +++ b/docs/ims/api-ref/en-us_topic_0037131984.html @@ -27,7 +27,7 @@

      String

      Specifies the image ID.

      -
      • image_id is the ID of the image you created by invoking the API for creating image metadata. Registration may fail if you use other image IDs.
      • After this API is invoked, you can check the image status with the image ID. When the image status changes to active, the image file is successfully registered. For details, see Querying Image Details (Native OpenStack API).
      +
      • image_id is the ID of the image you created by invoking the API for creating image metadata. Registration may fail if you use other image IDs.
      • After this API is invoked, you can check the image status with the image ID. When the image status changes to active, the image file is successfully registered. For details, see Querying Image Details (Native OpenStack API).
      @@ -64,15 +64,16 @@

    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

    • Response parameters

      Parameter

      @@ -95,13 +96,14 @@
    • Example response
      HTTP/1.1 200
      -
      1
-2
-3
      {
-   "job_id":" b912fb4a4c464b568ecfca1071b21b10"
+
      1
+2
+3
      {
+   "job_id":" b912fb4a4c464b568ecfca1071b21b10"
 }
-
      
-
      
+
      + +

    Returned Values

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0049147856.html b/docs/ims/api-ref/en-us_topic_0049147856.html index 8dc955d1..9fd43808 100644 --- a/docs/ims/api-ref/en-us_topic_0049147856.html +++ b/docs/ims/api-ref/en-us_topic_0049147856.html @@ -88,19 +88,20 @@

    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

    • Response parameters

      Parameter

      @@ -123,13 +124,14 @@
    • Example response
      STATUS CODE 200
      -
      1
-2
-3
      {
-    "job_id": "edc89b490d7d4392898e19b2deb34797"
+
      1
+2
+3
      {
+    "job_id": "edc89b490d7d4392898e19b2deb34797"
 }
-
      
-
      
+
      + +

    Returned Values

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0049147876.html b/docs/ims/api-ref/en-us_topic_0049147876.html index 17ff0af3..71c28210 100644 --- a/docs/ims/api-ref/en-us_topic_0049147876.html +++ b/docs/ims/api-ref/en-us_topic_0049147876.html @@ -39,77 +39,78 @@
  • 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

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0049147877.html b/docs/ims/api-ref/en-us_topic_0049147877.html index 0f653952..85ddda55 100644 --- a/docs/ims/api-ref/en-us_topic_0049147877.html +++ b/docs/ims/api-ref/en-us_topic_0049147877.html @@ -73,111 +73,112 @@
  • 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

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0060804959.html b/docs/ims/api-ref/en-us_topic_0060804959.html index 6f7d108c..0dcf5cf4 100644 --- a/docs/ims/api-ref/en-us_topic_0060804959.html +++ b/docs/ims/api-ref/en-us_topic_0060804959.html @@ -113,7 +113,7 @@

      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.

      min_ram

      @@ -241,7 +241,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. For details about the image OSs supported by large-memory ECSs, see Table 4.

      +

      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 details about the image OSs supported by large-memory ECSs, see Table 4.

      __support_diskintensive

      @@ -250,7 +250,7 @@

      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. For details about the image OSs supported by disk-intensive ECSs, see Table 4.

      +

      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. For details about the image OSs supported by disk-intensive ECSs, see Table 4.

      __support_highperformance

      @@ -259,7 +259,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. For details about the image OSs supported by high-performance computing ECSs, see Table 4.

      +

      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. For details about the image OSs supported by high-performance computing ECSs, see Table 4.

      __support_xen_gpu_type

      @@ -277,7 +277,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

      @@ -287,7 +287,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

      @@ -297,7 +297,7 @@

      String

      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.

      +

      This attribute cannot co-exist with __support_xen.

      created_at

      @@ -319,10 +319,10 @@

      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.

      +

      The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.

      For example, to query images updated before Oct 28, 2018 10:00:00, set the value of updated_at to lt:2018-10-28T10:00:00Z.

      @@ -345,7 +345,7 @@ 
      GET https://{Endpoint}/v2/images

    Response

    • Response parameters -
      -

      Parameter

      +
      @@ -364,7 +364,7 @@ -

      Parameter

      Type

      String

      Specifies the URL of the next page of images. When the last page of images is queried, there is no parameter next.

      +

      Specifies the URL of the next page of images. When the last page of images is queried, there is no parameter next.

      schema

      @@ -386,7 +386,7 @@
      -
      Table 2 Data structure description of the images field

      Parameter

      +
      @@ -447,7 +447,7 @@ - - - - - - - - - -
      Table 2 Data structure description of the images field

      Parameter

      Type

      String

      Specifies whether the image is available. The value can be true. The value is true for all extension APIs by default. Common users can query only the images for which the value of this parameter is true.

      +

      Specifies whether the image is available. The value can be true. The value is true for all extension APIs by default. Common users can query only the images for which the value of this parameter is true.

      __lazyloading

      @@ -469,14 +469,14 @@

      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.
      +
      • Public image: The value is gold.
      • Private image: The value is private.
      • Shared image: The value is shared.

      protected

      Boolean

      Specifies whether the image is protected. Set it to true when you query public images. This parameter is optional when you query private images.

      +

      Specifies whether the image is protected. Set it to true when you query public images. This parameter is optional when you query private images.

      virtual_env_type

      @@ -521,7 +521,7 @@

      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.
      +
      • 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.

      name

      @@ -542,14 +542,14 @@

      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.

      min_ram

      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

      @@ -633,14 +633,14 @@

      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

      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

      @@ -668,30 +668,30 @@

      String

      Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. For details about the image OSs supported by GPU-accelerated ECSs, see Table 2. 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. For details about the image OSs supported by GPU-accelerated ECSs, see Table 2. 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

      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

      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

      String

      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.

      +

      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.

      __root_origin

      @@ -706,7 +706,7 @@

      String

      Specifies the ECS system disk slot number of the image.

      -

      Example value: 0

      +

      Example value: 0

      __support_fc_inject

      @@ -775,7 +775,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.
      +
      • 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.

      __support_amd

      @@ -803,145 +803,146 @@
    • 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
      {
-  "schema": "/v2/schemas/images",
-  "next": "/v2/images?__isregistered=true&marker=0328c25e-c840-4496-81ac-c4e01b214b1f&__imagetype=gold&limit=2",
-  "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"
-    },
-    {
-      "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"
-    }
-  ],
-  "first": "/v2/images?__isregistered=true&__imagetype=gold&limit=2"
+
       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
      {
+  "schema": "/v2/schemas/images",
+  "next": "/v2/images?__isregistered=true&marker=0328c25e-c840-4496-81ac-c4e01b214b1f&__imagetype=gold&limit=2",
+  "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"
+    },
+    {
+      "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"
+    }
+  ],
+  "first": "/v2/images?__isregistered=true&__imagetype=gold&limit=2"
 }
-
      
-
      
+
      + +

      • Returned Values

      • Normal

        200

        diff --git a/docs/ims/api-ref/en-us_topic_0060804960.html b/docs/ims/api-ref/en-us_topic_0060804960.html index 8c0973b9..30e2f495 100644 --- a/docs/ims/api-ref/en-us_topic_0060804960.html +++ b/docs/ims/api-ref/en-us_topic_0060804960.html @@ -34,9 +34,9 @@

      Request

      • Request parameters

        Glance has two methods of updating image information. The method is specified by Content-Type in the HTTP header. application/openstack-images-v2.0-json-patch and application/openstack-images-v2.1-json-patch are supported. Content types differ only in the format of the request message body.

        -
        @@ -396,25 +396,26 @@
        Table 2 v2.1 request message body

        Parameter

        +
        - @@ -61,7 +61,7 @@ - @@ -101,9 +101,9 @@
        Table 2 v2.1 request message body

        Parameter

        Mandatory

        +

        Mandatory

        Type

        Type

        Mandatory

        +

        Mandatory

        Description

        -
        Table 4 v2.0 request message body

        Parameter

        +
        - @@ -128,7 +128,7 @@ - @@ -161,7 +161,7 @@ - @@ -171,46 +171,48 @@ -

        Example Request

        • Changing the name of an image to ims_test01 (V2.1 request)
        Table 4 v2.0 request message body

        Parameter

        Mandatory

        +

        Mandatory

        Type

        Type

        Mandatory

        +

        Mandatory

        Description

        String

        Mandatory for replace and add, and not for remove

        +

        Mandatory for replace and add, and not for remove

        Indicates the value of the attribute to be updated or added. For detailed description, see Image Attributes.

        		 
        1
-2
-3
-4
-5
-6
-7
-8
-9
        PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00
-"Content-Type:application/openstack-images-v2.1-json-patch"   
+
        Example Request
        • Changing the name of an image to ims_test01 (V2.1 request)
          1
+2
+3
+4
+5
+6
+7
+8
+9
          PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00
+"Content-Type:application/openstack-images-v2.1-json-patch"   
 [
-     {
-         "op": "replace",
-         "path": "/name",
-         "value": "test01"
-     }
+     {
+         "op": "replace",
+         "path": "/name",
+         "value": "test01"
+     }
 ]
-
          
-
          
-
        • Changing the name of an image to ims_test01 (V2.0 request)
          1
-2
-3
-4
-5
-6
-7
-8
          PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00
+
          
+
+
        
+
      • Changing the name of an image to ims_test01 (V2.0 request)
        1
+2
+3
+4
+5
+6
+7
+8
        PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00
 "Content-Type:application/openstack-images-v2.0-json-patch"
 [
-     {
-         "replace": "/name",
-         "value": "test01"       
-     }
-]     
-
        
-
        
+     {
+         "replace": "/name",
+         "value": "test01"       
+     }
+]     
+
        • + +

        Response

        • Response parameters -

          Parameter

          +
          @@ -357,7 +359,7 @@ -

          Parameter

          Type

          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

          @@ -646,79 +648,80 @@
        • 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
          {  
-    "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",  
-    "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",  
-    "__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
          {  
+    "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",  
+    "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",  
+    "__data_origin": null,
+    "hw_firmware_type":"bios"
 }
-
          
-
          
+
          + +

          • Returned Values

          • Normal

            200

            diff --git a/docs/ims/api-ref/en-us_topic_0066978719.html b/docs/ims/api-ref/en-us_topic_0066978719.html index 4016858f..9beb99af 100644 --- a/docs/ims/api-ref/en-us_topic_0066978719.html +++ b/docs/ims/api-ref/en-us_topic_0066978719.html @@ -92,115 +92,116 @@
        • Example response
          STATUS CODE 300
          -
           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
          {
-    "versions": [
-        {
-            "status": "CURRENT",
-            "id": "v2.2",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v2/",
-                    "rel": "self"
-                }
-            ]
-        },
-        {
-            "status": "SUPPORTED",
-            "id": "v2.1",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v2/",
-                    "rel": "self"
-                }
-            ]
-        },
-        {
-            "status": "SUPPORTED",
-            "id": "v2.0",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v2/",
-                    "rel": "self"
-                }
-            ]
-        },
-        {
-            "status": "DEPRECATED",
-            "id": "v1.1",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v1/",
-                    "rel": "self"
-                }
-            ]
-        },
-        {
-            "status": "DEPRECATED",
-            "id": "v1.0",
-            "links": [
-                {
-                    "href": "https://image.az1.dc1.domainname.com/v1/",
-                    "rel": "self"
-                }
-            ]
-        }
-    ]
+
           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
          {
+    "versions": [
+        {
+            "status": "CURRENT",
+            "id": "v2.2",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v2/",
+                    "rel": "self"
+                }
+            ]
+        },
+        {
+            "status": "SUPPORTED",
+            "id": "v2.1",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v2/",
+                    "rel": "self"
+                }
+            ]
+        },
+        {
+            "status": "SUPPORTED",
+            "id": "v2.0",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v2/",
+                    "rel": "self"
+                }
+            ]
+        },
+        {
+            "status": "DEPRECATED",
+            "id": "v1.1",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v1/",
+                    "rel": "self"
+                }
+            ]
+        },
+        {
+            "status": "DEPRECATED",
+            "id": "v1.0",
+            "links": [
+                {
+                    "href": "https://image.az1.dc1.domainname.com/v1/",
+                    "rel": "self"
+                }
+            ]
+        }
+    ]
 }
-
          
-
          
+
          + +

        Returned Values

        • Normal

          300

          diff --git a/docs/ims/api-ref/en-us_topic_0066978720.html b/docs/ims/api-ref/en-us_topic_0066978720.html index 04389211..5a138e9c 100644 --- a/docs/ims/api-ref/en-us_topic_0066978720.html +++ b/docs/ims/api-ref/en-us_topic_0066978720.html @@ -228,65 +228,66 @@
      • Example response
        HTTP/1.1 200 OK
        -
         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
        Content-Type: application/json; charset=UTF-8
-Content-Length: 495
-X-Openstack-Request-Id: req-68327dda-8078-41fe-b091-01a09ec073da
-Date: Mon, 23 May 2016 02:32:28 GMT
+
         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
        Content-Type: application/json; charset=UTF-8
+Content-Length: 495
+X-Openstack-Request-Id: req-68327dda-8078-41fe-b091-01a09ec073da
+Date: Mon, 23 May 2016 02:32:28 GMT
 {
-    "images": [
-        {
-            "status": "active",
-            "deleted_at": null,
-            "name": "cirros",
-            "deleted": false,
-            "container_format": "bare",
-            "created_at": "2016-05-22T06:04:20.425843",
-            "disk_format": "qcow2",
-            "updated_at": "2016-05-22T06:04:22.719791",
-            "min_disk": 0,
-            "protected": false,
-            "id": "3c3d1d01-b48a-4639-8a88-08be3b9b5d78",
-            "min_ram": 0,
-            "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
-            "owner": "23f4cb75768d4febb39542ef6fe169f3",
-            "is_public": true,
-            "virtual_size": null,
-            "properties": {
-            },
-            "size": 13167616
-        }
-    ]
+    "images": [
+        {
+            "status": "active",
+            "deleted_at": null,
+            "name": "cirros",
+            "deleted": false,
+            "container_format": "bare",
+            "created_at": "2016-05-22T06:04:20.425843",
+            "disk_format": "qcow2",
+            "updated_at": "2016-05-22T06:04:22.719791",
+            "min_disk": 0,
+            "protected": false,
+            "id": "3c3d1d01-b48a-4639-8a88-08be3b9b5d78",
+            "min_ram": 0,
+            "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
+            "owner": "23f4cb75768d4febb39542ef6fe169f3",
+            "is_public": true,
+            "virtual_size": null,
+            "properties": {
+            },
+            "size": 13167616
+        }
+    ]
 }
-
        
-
        
+
        + +

        • Returned Values

        • Normal

          200

          diff --git a/docs/ims/api-ref/en-us_topic_0066978721.html b/docs/ims/api-ref/en-us_topic_0066978721.html index 9695ca44..e9662067 100644 --- a/docs/ims/api-ref/en-us_topic_0066978721.html +++ b/docs/ims/api-ref/en-us_topic_0066978721.html @@ -176,47 +176,48 @@

        These parameters are contained in the header of the HTTP response message.

      • Example response
        HTTP/1.1 200 OK
        -
         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
        Content-Type: text/html; charset=UTF-8
-Content-Length: 0
-X-Image-Meta-Id: 3c3d1d01-b48a-4639-8a88-08be3b9b5d78
-X-Image-Meta-Deleted: False
-X-Image-Meta-Container_format: bare
-X-Image-Meta-Checksum: 64d7c1cd2b6f60c92c14662941cb7913
-X-Image-Meta-Protected: False
-X-Image-Meta-Min_disk: 0
-X-Image-Meta-Created_at: 2016-05-22T06:04:20.425843
-X-Image-Meta-Size: 13167616
-X-Image-Meta-Status: active
-X-Image-Meta-Is_public: True
-X-Image-Meta-Min_ram: 0
-X-Image-Meta-Owner: 23f4cb75768d4febb39542ef6fe169f3
-X-Image-Meta-Updated_at: 2016-05-22T06:04:22.719791
-X-Image-Meta-Disk_format: qcow2
-X-Image-Meta-Name: cirros
-Etag: 64d7c1cd2b6f60c92c14662941cb7913
-X-Openstack-Request-Id: req-7123ca83-da23-4f4e-9ed6-accd3707d333
-Date: Mon, 23 May 2016 02:29:54 GMT
-
        -
        +
         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
        Content-Type: text/html; charset=UTF-8
+Content-Length: 0
+X-Image-Meta-Id: 3c3d1d01-b48a-4639-8a88-08be3b9b5d78
+X-Image-Meta-Deleted: False
+X-Image-Meta-Container_format: bare
+X-Image-Meta-Checksum: 64d7c1cd2b6f60c92c14662941cb7913
+X-Image-Meta-Protected: False
+X-Image-Meta-Min_disk: 0
+X-Image-Meta-Created_at: 2016-05-22T06:04:20.425843
+X-Image-Meta-Size: 13167616
+X-Image-Meta-Status: active
+X-Image-Meta-Is_public: True
+X-Image-Meta-Min_ram: 0
+X-Image-Meta-Owner: 23f4cb75768d4febb39542ef6fe169f3
+X-Image-Meta-Updated_at: 2016-05-22T06:04:22.719791
+X-Image-Meta-Disk_format: qcow2
+X-Image-Meta-Name: cirros
+Etag: 64d7c1cd2b6f60c92c14662941cb7913
+X-Openstack-Request-Id: req-7123ca83-da23-4f4e-9ed6-accd3707d333
+Date: Mon, 23 May 2016 02:29:54 GMT
+
        + +

        • Returned Values

        • Normal

          200

          diff --git a/docs/ims/api-ref/en-us_topic_0066978722.html b/docs/ims/api-ref/en-us_topic_0066978722.html index 85144635..42efbd1d 100644 --- a/docs/ims/api-ref/en-us_topic_0066978722.html +++ b/docs/ims/api-ref/en-us_topic_0066978722.html @@ -38,15 +38,16 @@

        Response

        • Response parameters

          None

        • Example response
          HTTP/1.1 200 OK
          -
          1
-2
-3
-4
          Content-Type: text/html; charset=UTF-8
-Content-Length: 0
-X-Openstack-Request-Id: req-75e9edca-7b43-47da-bdc5-d39be469b72f
-Date: Mon, 23 May 2016 02:43:34 GMT
-
          -
          +
          1
+2
+3
+4
          Content-Type: text/html; charset=UTF-8
+Content-Length: 0
+X-Openstack-Request-Id: req-75e9edca-7b43-47da-bdc5-d39be469b72f
+Date: Mon, 23 May 2016 02:43:34 GMT
+
          + +

        Returned Values

        • Normal

          204

          diff --git a/docs/ims/api-ref/en-us_topic_0067360381.html b/docs/ims/api-ref/en-us_topic_0067360381.html index dcd5e4e0..8213cf26 100644 --- a/docs/ims/api-ref/en-us_topic_0067360381.html +++ b/docs/ims/api-ref/en-us_topic_0067360381.html @@ -83,28 +83,30 @@
        -

        Example Request

        • Adding or modifying a tag (parameter: tags)
          1
-2
-3
-4
-5
          PUT https://{Endpoint}/v1/cloudimages/tags
+
          Example Request
          • Adding or modifying a tag (parameter: tags)
            1
+2
+3
+4
+5
            PUT https://{Endpoint}/v1/cloudimages/tags
 {
-  "image_id": "62a15f6c-9197-44d2-89c7-708981c1bec1",
-  "tag": "aaaa.1111"
+  "image_id": "62a15f6c-9197-44d2-89c7-708981c1bec1",
+  "tag": "aaaa.1111"
 }
-
            
-
            
-
          • Adding or modifying a tag (parameter: image_tag)
            1
-2
-3
-4
-5
            PUT https://{Endpoint}/v1/cloudimages/tags
+
            
+
+
          
+
        • Adding or modifying a tag (parameter: image_tag)
          1
+2
+3
+4
+5
          PUT https://{Endpoint}/v1/cloudimages/tags
 {
-  "image_id": "67437ebd-2563-46e0-887e-ad1923977fa1",
-  "image_tag": {"key":"key1","value":"value1"}
+  "image_id": "67437ebd-2563-46e0-887e-ad1923977fa1",
+  "image_tag": {"key":"key1","value":"value1"}
 }
-
          
-
          
+
          • + +

        Response

        • Response parameters

          None

          diff --git a/docs/ims/api-ref/en-us_topic_0067360382.html b/docs/ims/api-ref/en-us_topic_0067360382.html index 5daf79b2..7c6d0818 100644 --- a/docs/ims/api-ref/en-us_topic_0067360382.html +++ b/docs/ims/api-ref/en-us_topic_0067360382.html @@ -361,7 +361,7 @@

        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.

        +

        The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.

        For example, to query images updated before Oct 28, 2018 10:00:00, set the value of updated_at as follows:

        updated_at=lt:2018-10-28T10:00:00Z

      • Example response
        STATUS CODE 200
        -
        1
-2
-3
-4
-5
-6
-7
-8
-9
        {
-   "tags": [
-      "jjjj.11111",
-      "uuuu.22222",
-      "234.4",
-      "test",
-      "image"
-   ]
+
        1
+2
+3
+4
+5
+6
+7
+8
+9
        {
+   "tags": [
+      "jjjj.11111",
+      "uuuu.22222",
+      "234.4",
+      "test",
+      "image"
+   ]
 }
-
        
-
        
+
        + +

      In the new specification, equal signs are used as separators.

      diff --git a/docs/ims/api-ref/en-us_topic_0083905788.html b/docs/ims/api-ref/en-us_topic_0083905788.html index 86493b48..ffd3dbe2 100644 --- a/docs/ims/api-ref/en-us_topic_0083905788.html +++ b/docs/ims/api-ref/en-us_topic_0083905788.html @@ -94,7 +94,7 @@

      Array of ImageTag 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

      @@ -145,50 +145,52 @@ -

      Example Request

      • Creating a data disk image with parameter tags using a file in an OBS bucket (file address in the bucket: image-test:fedora_data1.qcow2; OS: Linux; minimum size of the data disk: 40 GB)
         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
        POST https://{Endpoint}/v1/cloudimages/dataimages/action
+
        Example Request
        • Creating a data disk image with parameter tags using a file in an OBS bucket (file address in the bucket: image-test:fedora_data1.qcow2; OS: Linux; minimum size of the data disk: 40 GB)
           1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
          POST https://{Endpoint}/v1/cloudimages/dataimages/action
 {
-  "name": "fedora-data1",
-  "image_url": "image-test:fedora_data1.qcow2",
-  "description":"Data disk 1 of Fedora",
-  "min_disk": 40,
-  "tags": [
-    "aaa.111",
-    "bbb.222"
-  ],
-  "os_type": "Linux"
+  "name": "fedora-data1",
+  "image_url": "image-test:fedora_data1.qcow2",
+  "description":"Data disk 1 of Fedora",
+  "min_disk": 40,
+  "tags": [
+    "aaa.111",
+    "bbb.222"
+  ],
+  "os_type": "Linux"
 }
-
          
-
          
-
        • Creating a data disk image with parameter image_tags using a file in an OBS bucket (file address in the bucket: image-test:fedora_data1.qcow2; OS: Linux; minimum size of the data disk: 40 GB)
          1
-2
-3
-4
-5
-6
-7
-8
-9
          POST https://{Endpoint}/v1/cloudimages/dataimages/action
+
          
+
+
        
+
      • Creating a data disk image with parameter image_tags using a file in an OBS bucket (file address in the bucket: image-test:fedora_data1.qcow2; OS: Linux; minimum size of the data disk: 40 GB)
        1
+2
+3
+4
+5
+6
+7
+8
+9
        POST https://{Endpoint}/v1/cloudimages/dataimages/action
 {
-  "name": "fedora-data2",
-  "image_url": "image-test:fedora_data1.qcow2",
-  "description":"Data disk 2 of Fedora",
-  "min_disk": 40,
-  "image_tags": [{"key":"aaa","value":"111"},{"key":"bbb","value":"222"}],
-  "os_type": "Linux"
+  "name": "fedora-data2",
+  "image_url": "image-test:fedora_data1.qcow2",
+  "description":"Data disk 2 of Fedora",
+  "min_disk": 40,
+  "image_tags": [{"key":"aaa","value":"111"},{"key":"bbb","value":"222"}],
+  "os_type": "Linux"
 }
-
        
-
        
+
        • + +

      Response

      • Response parameters @@ -212,13 +214,14 @@
    • Example response
      STATUS CODE 200
      -
      1
-2
-3
      {
-    "job_id": "4010a32b5f909853015f90aaa24b0015"
+
      1
+2
+3
      {
+    "job_id": "4010a32b5f909853015f90aaa24b0015"
 }
-
      
-
      
+
      + +

      • Returned Values

      • Normal

        200

        diff --git a/docs/ims/api-ref/en-us_topic_0092380109.html b/docs/ims/api-ref/en-us_topic_0092380109.html index ec47a757..28475c7a 100644 --- a/docs/ims/api-ref/en-us_topic_0092380109.html +++ b/docs/ims/api-ref/en-us_topic_0092380109.html @@ -39,7 +39,7 @@

      Constraints (Creating a Full-ECS Image Using a CSBS Backup)

      • When creating a full-ECS image from a CSBS backup, ensure that the source ECS of the CSBS backup has been properly configured, or the image creation may fail.
      • If an ECS is in Stopped state, do not start it when you are using it to create a full-ECS image.
      • A CSBS backup used to create a full-ECS image cannot have shared disks.
      • Only an available CSBS backup can be used to create a full-ECS image. A CSBS backup can be used to create only one full-ECS image.
      • A full-ECS image cannot be exported or replicated.
      -

      Constraints (Creating a Full-ECS Image Using a CBR Backup)

      • When creating a full-ECS image from a CBR backup, ensure that the source ECS of the CBR backup has been properly configured, or the image creation may fail.
      • A CBR backup can be used to create only one full-ECS image.
      • If an ECS is in Stopped state, do not start it when you are using it to create a full-ECS image.
      • A full-ECS image created from a CBR backup can be shared with other tenants. However, if it is a shared CBR backup, the full-ECS image created from it cannot be shared.
      • A full-ECS image cannot be exported or replicated.
      +

      Constraints (Creating a Full-ECS Image Using a CBR Backup)

      • When creating a full-ECS image from a CBR backup, ensure that the source ECS of the CBR backup has been properly configured, or the image creation may fail.
      • A CBR backup can be used to create only one full-ECS image.
      • If an ECS is in Stopped state, do not start it when you are using it to create a full-ECS image.
      • A full-ECS image created from a CBR backup can be shared with other tenants. However, if it is a shared CBR backup, the full-ECS image created from it cannot be shared.
      • A full-ECS image cannot be exported or replicated.

      URI

      POST /v1/cloudimages/wholeimages/action

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

      instance_id

      @@ -182,7 +182,7 @@

      Array of strings

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

      -

      Use either tags or image_tags.

      +

      Use either tags or image_tags.

      image_tags

      @@ -234,7 +234,7 @@

      Integer

      Specifies the minimum memory of the image in the unit of MB. The default value is 0, indicating that the memory is not restricted.

      +

      Specifies the minimum memory of the image in the unit of MB. The default value is 0, indicating that the memory is not restricted.

      whole_image_type

      @@ -252,90 +252,94 @@ -

      Example Request

      • Creating a full-ECS image with parameter tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
        POST https://{Endpoint}/v1/cloudimages/wholeimages/action
+
        Example Request
        • Creating a full-ECS image with parameter tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
           1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
          POST https://{Endpoint}/v1/cloudimages/wholeimages/action
 {
-       "name": "instance_whole_image",
-       "description": "creating an image from an ECS",
-       "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
-       "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600",
-       "tags": [
-           "aaa.111",
-           "bbb.333",
-           "ccc.444"
-       ]
+       "name": "instance_whole_image",
+       "description": "creating an image from an ECS",
+       "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
+       "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600",
+       "tags": [
+           "aaa.111",
+           "bbb.333",
+           "ccc.444"
+       ]
 }
-
          
-
          
-
        • Creating a full-ECS image with parameter image_tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
          1
-2
-3
-4
-5
-6
-7
-8
          POST https://{Endpoint}/v1/cloudimages/wholeimages/action
+
          
+
+
        
+
      • Creating a full-ECS image with parameter image_tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
        1
+2
+3
+4
+5
+6
+7
+8
        POST https://{Endpoint}/v1/cloudimages/wholeimages/action
 {
-       "name": "instance_whole_image",
-       "description": "creating an image from an ECS",
-       "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
-       "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600",
-       "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
-} 
-
        
-
        
-
      • Creating a full-ECS image with parameter tags using aCSBS backup or CBR backup (ID: 9b27efab-4a17-4c06-bfa2-3e0cf021d3c3)
         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
        POST https://{Endpoint}/v1/cloudimages/wholeimages/action
+       "name": "instance_whole_image",
+       "description": "creating an image from an ECS",
+       "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
+       "vault_id": "de9fcf45-11b2-432c-8562-5c5428574600",
+       "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
+} 
+
        
+
+
        • +
      • Creating a full-ECS image with parameter tags using aCSBS backup or CBR backup (ID: 9b27efab-4a17-4c06-bfa2-3e0cf021d3c3)
         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
        POST https://{Endpoint}/v1/cloudimages/wholeimages/action
 {
-     "name": "backup_whole_image",
-     "description": "Creating a full-ECS image from a CBR backup",
-     "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3",
-     "whole_image_type": "CBR",
-     "tags": [
-           "aaa.111",
-           "bbb.333",
-           "ccc.444"
-      ]
+     "name": "backup_whole_image",
+     "description": "Creating a full-ECS image from a CBR backup",
+     "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3",
+     "whole_image_type": "CBR",
+     "tags": [
+           "aaa.111",
+           "bbb.333",
+           "ccc.444"
+      ]
 }
-
        -
        -
      • Creating a full-ECS image with parameter image_tags using aCSBS backup or CBR backup (ID: 9b27efab-4a17-4c06-bfa2-3e0cf021d3c3)
        1
-2
-3
-4
-5
-6
-7
-8
        POST https://{Endpoint}/v1/cloudimages/wholeimages/action
+
        + + +
      • Creating a full-ECS image with parameter image_tags using aCSBS backup or CBR backup (ID: 9b27efab-4a17-4c06-bfa2-3e0cf021d3c3)
        1
+2
+3
+4
+5
+6
+7
+8
        POST https://{Endpoint}/v1/cloudimages/wholeimages/action
 {
-     "name": "backup_whole_image",
-     "description": "Creating a full-ECS image from a CBR backup",
-     "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3",
-     "whole_image_type": "CBR",
-     "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
+     "name": "backup_whole_image",
+     "description": "Creating a full-ECS image from a CBR backup",
+     "backup_id": "9b27efab-4a17-4c06-bfa2-3e0cf021d3c3",
+     "whole_image_type": "CBR",
+     "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
 }
-
        -
        +
        • + +

      Response

      • Response parameters @@ -359,13 +363,14 @@
    • Example response
      STATUS CODE 200
      -
      1
-2
-3
      {
-    "job_id": "4010a32b5f909853015f90aaa24b0015"
+
      1
+2
+3
      {
+    "job_id": "4010a32b5f909853015f90aaa24b0015"
 }
-
      
-
      
+
      + +

    Returned Values

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0093967372.html b/docs/ims/api-ref/en-us_topic_0093967372.html index 5c637d08..9ba3d38d 100644 --- a/docs/ims/api-ref/en-us_topic_0093967372.html +++ b/docs/ims/api-ref/en-us_topic_0093967372.html @@ -99,33 +99,34 @@
  • 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

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0102682861.html b/docs/ims/api-ref/en-us_topic_0102682861.html index 4a327dc1..e40668c7 100644 --- a/docs/ims/api-ref/en-us_topic_0102682861.html +++ b/docs/ims/api-ref/en-us_topic_0102682861.html @@ -295,121 +295,123 @@
    -

    Example Request

    • Counting the total number of images that meet the conditions specified by tags
       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
      POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/resource_instances/action
+
      Example Request
      • Counting the total number of images that meet the conditions specified by tags
         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
        POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/resource_instances/action
 {
-   "action": "count",
-   "matches": [{
-      "key": "resource_name",
-      "value": "test100"
-   }],
-   "tags": [
-   {
-      "key": "key3",
-      "values": ["valueXX"]
-   }],
-   "tags_any": [
-   {
-      "key": "key0",
-      "values": ["valueXX"]
-   }],
-      "not_tags": [
-   {
-      "key": "key9",
-      "values": ["value9"]
-   }],
-   "not_tags_any": [{
-      "key": "key7",
-      "values": ["value7"]
-   }]
+   "action": "count",
+   "matches": [{
+      "key": "resource_name",
+      "value": "test100"
+   }],
+   "tags": [
+   {
+      "key": "key3",
+      "values": ["valueXX"]
+   }],
+   "tags_any": [
+   {
+      "key": "key0",
+      "values": ["valueXX"]
+   }],
+      "not_tags": [
+   {
+      "key": "key9",
+      "values": ["value9"]
+   }],
+   "not_tags_any": [{
+      "key": "key7",
+      "values": ["value7"]
+   }]
 }
-
        
-
        
+
      + +
    -
    • Filtering images that meet the conditions specified by tags
       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
      POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/resource_instances/action
+
      • Filtering images that meet the conditions specified by tags
         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
        POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/resource_instances/action
 {
-   "action": "filter",
-   "limit": "1",
-   "offset": "0",
-   "matches": [{
-      "key": "resource_name",
-      "value": "test100"
-   }],
-   "tags": [
-   {
-      "key": "key3",
-      "values": ["valueXX"]
-   }],
-   "tags_any": [
-   {
-      "key": "key0",
-      "values": ["valueXX"]
-   }],
-   "not_tags": [
-   {
-      "key": "key9",
-      "values": ["value9"]
-   }],
-   "not_tags_any": [{
-      "key": "key7",
-      "values": ["value7"]
-   }]
+   "action": "filter",
+   "limit": "1",
+   "offset": "0",
+   "matches": [{
+      "key": "resource_name",
+      "value": "test100"
+   }],
+   "tags": [
+   {
+      "key": "key3",
+      "values": ["valueXX"]
+   }],
+   "tags_any": [
+   {
+      "key": "key0",
+      "values": ["valueXX"]
+   }],
+   "not_tags": [
+   {
+      "key": "key9",
+      "values": ["value9"]
+   }],
+   "not_tags_any": [{
+      "key": "key7",
+      "values": ["value7"]
+   }]
 }
-
        
-
        
+
      + +

    Response

    • Response parameters @@ -529,111 +531,113 @@
    • Example response
      • Example response when action is set to count
        STATUS CODE 200
        -
        1
-2
-3
        {
-   "total_count": 36
+
        1
+2
+3
        {
+   "total_count": 36
 }
-
        
-
        
+
        + +
      • Example response when action is set to filter
        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
        {
-   "total_count": 36,
-   "resources": [{
-      "resource_name": "test10002",
-      "resource_detail": {"status": "active"},
-      "tags": [{
-         "value": "value4",
-         "key": "key4"
-      },
-      {
-         "value": "valueXX",
-         "key": "key3"
-      },
-      {
-         "value": "value2",
-         "key": "key2"
-      },
-      {
-         "value": "value5",
-         "key": "key5"
-      },
-      {
-         "value": "value8",
-         "key": "key8"
-      },
-      {
-         "value": "valueXX",
-         "key": "key6"
-      },
-      {
-         "value": "valueXX",
-         "key": "key0"
-      },
-      {
-         "value": "value1",
-         "key": "key1"
-      },
-      {
-         "value": "value7",
-         "key": "key7"
-      },
-      {
-         "value": "valueXX",
-         "key": "key9"
-      }],
-      "resource_id": "8693187d-1590-4f9f-ae34-eb9e3037cf68"
-   }]
+
         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
        {
+   "total_count": 36,
+   "resources": [{
+      "resource_name": "test10002",
+      "resource_detail": {"status": "active"},
+      "tags": [{
+         "value": "value4",
+         "key": "key4"
+      },
+      {
+         "value": "valueXX",
+         "key": "key3"
+      },
+      {
+         "value": "value2",
+         "key": "key2"
+      },
+      {
+         "value": "value5",
+         "key": "key5"
+      },
+      {
+         "value": "value8",
+         "key": "key8"
+      },
+      {
+         "value": "valueXX",
+         "key": "key6"
+      },
+      {
+         "value": "valueXX",
+         "key": "key0"
+      },
+      {
+         "value": "value1",
+         "key": "key1"
+      },
+      {
+         "value": "value7",
+         "key": "key7"
+      },
+      {
+         "value": "valueXX",
+         "key": "key9"
+      }],
+      "resource_id": "8693187d-1590-4f9f-ae34-eb9e3037cf68"
+   }]
 }
-
        
-
        
+
        + +
    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

    • Adding tags for an image (key1:value1, key2:value2)
       1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
      POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
+
      Example Request
      • Adding tags for an image (key1:value1, key2:value2)
         1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
        POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
 {
-   "tags": [{
-      "value": "value1",
-      "key": "key1"
-   },
-   {
-      "value": "value2",
-      "key": "key2"
-   },
-   {
-      "value": "",
-      "key": "key3"
-   }],
-   "action": "create"
+   "tags": [{
+      "value": "value1",
+      "key": "key1"
+   },
+   {
+      "value": "value2",
+      "key": "key2"
+   },
+   {
+      "value": "",
+      "key": "key3"
+   }],
+   "action": "create"
 }
-
        
-
        
-
      • Deleting image tags (key1:value1, key2:value2)
         1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
        POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
+
        
+
+
      
+
    • Deleting image tags (key1:value1, key2:value2)
       1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
      POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
 {
-   "tags": [{
-      "value": "value1",
-      "key": "key1"
-   },
-   {
-      "value": "value2",
-      "key": "key2"
-   },
-   {
-      "value": "",
-      "key": "key3"
-   }],
-      "action": "delete"
+   "tags": [{
+      "value": "value1",
+      "key": "key1"
+   },
+   {
+      "value": "value2",
+      "key": "key2"
+   },
+   {
+      "value": "",
+      "key": "key3"
+   }],
+      "action": "delete"
 }
-
      
-
      
+
      • + +

    Response

    • Response parameters

      None

      diff --git a/docs/ims/api-ref/en-us_topic_0102682863.html b/docs/ims/api-ref/en-us_topic_0102682863.html index a4ce0c72..db93948a 100644 --- a/docs/ims/api-ref/en-us_topic_0102682863.html +++ b/docs/ims/api-ref/en-us_topic_0102682863.html @@ -98,21 +98,22 @@

    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

    • Response parameters

      None

    • Example response
      STATUS CODE 204
      diff --git a/docs/ims/api-ref/en-us_topic_0102682865.html b/docs/ims/api-ref/en-us_topic_0102682865.html index 7e9886f7..d86f3dfe 100644 --- a/docs/ims/api-ref/en-us_topic_0102682865.html +++ b/docs/ims/api-ref/en-us_topic_0102682865.html @@ -90,27 +90,28 @@
  • 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

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0102682866.html b/docs/ims/api-ref/en-us_topic_0102682866.html index d3a3ed9f..23bbe4db 100644 --- a/docs/ims/api-ref/en-us_topic_0102682866.html +++ b/docs/ims/api-ref/en-us_topic_0102682866.html @@ -81,39 +81,40 @@
  • 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

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0133188204.html b/docs/ims/api-ref/en-us_topic_0133188204.html index 237ea894..828dba9a 100644 --- a/docs/ims/api-ref/en-us_topic_0133188204.html +++ b/docs/ims/api-ref/en-us_topic_0133188204.html @@ -5,7 +5,7 @@

      The fast image creation function is only available for image files in RAW or ZVHD2 format. For other formats of image files that are smaller than 128 GB, you are advised to import these files with the common method.

      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.

    -

    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.
    +

    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

    • Normal

      200

      diff --git a/docs/ims/api-ref/en-us_topic_0170918588.html b/docs/ims/api-ref/en-us_topic_0170918588.html index 10a2c4b8..d9474afb 100644 --- a/docs/ims/api-ref/en-us_topic_0170918588.html +++ b/docs/ims/api-ref/en-us_topic_0170918588.html @@ -116,35 +116,36 @@
  • 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

    • Normal

      300

      diff --git a/docs/ims/api-ref/test1703560485403.txt b/docs/ims/api-ref/test1703560485403.txt deleted file mode 100644 index ab16c760..00000000 --- a/docs/ims/api-ref/test1703560485403.txt +++ /dev/null @@ -1 +0,0 @@ -D:\02CBR\13gitea\doc-exports\docs\ims\api-ref