diff --git a/docs/ims/api-ref/en-us_topic_0022473688.html b/docs/ims/api-ref/en-us_topic_0022473688.html
index d6d103b2..4d13a5b7 100644
--- a/docs/ims/api-ref/en-us_topic_0022473688.html
+++ b/docs/ims/api-ref/en-us_topic_0022473688.html
@@ -65,6 +65,7 @@
begin_time
@@ -108,7 +109,7 @@
-Table 2 Data structure description of the entities fieldParameter
+Table 2 Data structure description of the entities fieldParameter
|
Type
|
@@ -202,7 +203,7 @@
|---|
Table 4 Data structure description of the SubJobResult fieldParameter
+Table 4 Data structure description of the SubJobResult fieldParameter
|
Type
|
@@ -215,7 +216,7 @@
String
|
Specifies the sub-job status. The value can be:
-- SUCCESS: The sub-job is successfully executed.
- FAIL: The sub-job failed to be executed.
- RUNNING: The sub-job is in progress.
- INIT: The sub-job is being initialized.
+- SUCCESS: The sub-job is successfully executed.
- FAIL: The sub-job failed to be executed.
- RUNNING: The sub-job is in progress.
- INIT: The sub-job is being initialized.
|
|---|
job_id
@@ -272,7 +273,7 @@
|
Table 5 Data structure description of the SubJobEntities fieldParameter
+Table 5 Data structure description of the SubJobEntities fieldParameter
|
Type
|
diff --git a/docs/ims/api-ref/en-us_topic_0022473689.html b/docs/ims/api-ref/en-us_topic_0022473689.html
index 35bdb8be..7e3f3f48 100644
--- a/docs/ims/api-ref/en-us_topic_0022473689.html
+++ b/docs/ims/api-ref/en-us_topic_0022473689.html
@@ -148,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.
|
@@ -423,7 +423,7 @@
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.
|
@@ -553,11 +553,11 @@
IMG.0056
|
-The OS type is invalid.
+ | Invalid OS version.
|
-The OS type is invalid.
+ | The OS version is invalid.
|
-Select Windows or Linux.
+ | Select a valid OS version.
|
|---|
400
@@ -1403,7 +1403,7 @@
|
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.
|
@@ -1918,11 +1918,11 @@
IMG.0212
|
-The value of architecture is not x86 or arm.
+ | The value of Architecture must be x86 or Arm.
|
-The value of architecture is not 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 5edcc14a..0f27f89c 100644
--- a/docs/ims/api-ref/en-us_topic_0024735403.html
+++ b/docs/ims/api-ref/en-us_topic_0024735403.html
@@ -8,7 +8,15 @@
|
-2023-02-01
+ | 2023-03-23
+ |
+Added the following content:
+Introduction
+Modified the following content:
+
+ |
+
+2023-02-01
|
Modified the following content:
@@ -47,7 +55,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:
|
@@ -78,7 +86,7 @@
2019-01-30
|
Modified the following content:
-
+
|
2018-09-30
@@ -191,7 +199,7 @@
|
2017-02-08
|
-Modified the following content: - Updated the values of __os_version.
+ Modified the following content: - Updated the values of __os_version.
|
|
@@ -213,7 +221,7 @@
2016-10-29
|
-Added the following content:
+ Added the following content:
|
|
diff --git a/docs/ims/api-ref/en-us_topic_0031615565.html b/docs/ims/api-ref/en-us_topic_0031615565.html
index 234ad760..47d1a694 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 @@
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
@@ -81,6 +81,9 @@
| Array of strings
|
Lists the image tags. The tag contains 1 to 255 characters. The value is left blank by default.
+ NOTE: The tag is a key-value pair. Example:
+ "tagkey=tagvalue"
+
|
min_ram
@@ -89,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
@@ -105,9 +108,6 @@
|
 Parameters in the request body are strings of no more than 255 characters, and their values can be left blank. Example:
- "key": "value"
- POST https://{Endpoint}/v2/images
{
"__os_version": "Ubuntu 14.04 server 64bit",
@@ -117,8 +117,8 @@
"min_ram": 1024,
"name": "test",
"tags": [
- "test",
- "image"
+ "test=testvalue",
+ "image=imagevalue"
],
"visibility": "private",
"protected": false
@@ -160,7 +160,7 @@
String
|
Specifies the container format.
-The value is bare.
+The value is bare.
|
|
|---|
disk_format
@@ -259,7 +259,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
@@ -303,7 +303,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 a 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 a data disk image, the value is DataImage.
- For a BMS image, the value is Ironic.
- For an ISO image, the value is IsoImage.
|
owner
@@ -371,8 +371,9 @@
"visibility": "private",
"virtual_env_type": "FusionCompute",
"tags": [
- "test",
- "image"
+ "test=testvalue",
+ "image=imagevalue"
+
],
"__platform": "Ubuntu",
"__os_bit": "64",
diff --git a/docs/ims/api-ref/en-us_topic_0036994315.html b/docs/ims/api-ref/en-us_topic_0036994315.html
index 10c73426..e3a121b4 100644
--- a/docs/ims/api-ref/en-us_topic_0036994315.html
+++ b/docs/ims/api-ref/en-us_topic_0036994315.html
@@ -5,7 +5,7 @@
Before exporting an image, ensure that you have the Tenant Administrator permission for OBS.
-Constraints- The following private images cannot be exported:
- Full-ECS images
- Private images created from a Windows, SUSE, Red Hat, Ubuntu, or Oracle Linux public image
+Constraints- The following private images cannot be exported:
- Full-ECS images
- Private images created from a Windows, SUSE, Red Hat, Ubuntu, or Oracle Linux public image
- The image size must be less than 1 TB. Images larger than 128 GB support only fast export.
URIPOST /v1/cloudimages/{image_id}/file
diff --git a/docs/ims/api-ref/en-us_topic_0060804959.html b/docs/ims/api-ref/en-us_topic_0060804959.html
index 4f9450f0..fdd53b78 100644
--- a/docs/ims/api-ref/en-us_topic_0060804959.html
+++ b/docs/ims/api-ref/en-us_topic_0060804959.html
@@ -176,7 +176,7 @@
|
String
|
-Specifies the field for sorting the query results. The value can be an attribute of the image: name, container_format, disk_format, status, id, size, or create_at. The default value is create_at.
+ | Specifies the field for sorting the query results. The value can be an attribute of the image: name, container_format, disk_format, status, id, size, or created_at. The default value is created_at.
|
sort_dir
@@ -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 the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+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.
|
@@ -343,7 +343,7 @@
Response- Response parameters
-
Parameter
+Parameter
|
Type
|
@@ -362,7 +362,7 @@
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
@@ -384,7 +384,7 @@
|
Table 2 Data structure description of the images fieldParameter
+Table 2 Data structure description of the images fieldParameter
|
Type
|
@@ -445,7 +445,7 @@
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
@@ -467,14 +467,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
@@ -519,7 +519,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
@@ -547,7 +547,7 @@
|
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
@@ -631,14 +631,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
@@ -666,30 +666,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 the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+ | Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen.
|
__root_origin
@@ -704,7 +704,7 @@
| String
|
Specifies the ECS system disk slot number corresponding to the image.
-Example value: 0
+Example value: 0
|
__support_fc_inject
diff --git a/docs/ims/api-ref/en-us_topic_0067360382.html b/docs/ims/api-ref/en-us_topic_0067360382.html
index 9c14ee4d..c219eb55 100644
--- a/docs/ims/api-ref/en-us_topic_0067360382.html
+++ b/docs/ims/api-ref/en-us_topic_0067360382.html
@@ -9,9 +9,9 @@
Table 1 Parameter descriptionParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
Description
|
@@ -19,194 +19,194 @@
|---|
__isregistered
|
-No
+ | No
|
-String
+ | 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.
|
__imagetype
|
-No
+ | No
|
-String
+ | String
|
Specifies the image type. The following types are supported:
-- Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
- NOTE: The __imagetype of images you share with other tenants or those other tenants share with you and you have accepted is shared. You can use field owner to distinguish the two types of shared images. You can use member_status to filter out shared images you have accepted.
+ - Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
+ NOTE: The __imagetype of images you share with other tenants or those other tenants share with you and you have accepted is shared. You can use field owner to distinguish the two types of shared images. You can use member_status to filter out shared images you have accepted.
|
__whole_image
|
-No
+ | No
|
-Boolean
+ | Boolean
|
-Specifies whether the image is a full-ECS image. The value can be true or false.
+ | Specifies whether the image is a full-ECS image. The value can be true or false.
|
__system__cmkid
|
-No
+ | No
|
-String
+ | String
|
Specifies the ID of the key used to encrypt the image. You can obtain the ID from the IMS console or by calling the Querying Image Details (Native OpenStack API) API.
|
protected
|
-No
+ | No
|
-Boolean
+ | Boolean
|
-Specifies whether the image is protected. The value can be true or false. Set it to true when you query public images. This parameter is optional when you query private images.
+ | Specifies whether the image is protected. The value can be true or false. Set it to true when you query public images. This parameter is optional when you query private images.
|
visibility
|
-No
+ | No
|
-String
+ | String
|
Specifies whether the image is available to other tenants. Available values include:
-- public: public image
- private: private image
- shared: shared image
+- public: public image
- private: private image
- shared: shared image
|
owner
|
-No
+ | No
|
-String
+ | String
|
Specifies the tenant to which the image belongs.
|
id
|
-No
+ | No
|
-String
+ | String
|
Specifies the image ID.
|
status
|
-No
+ | No
|
-String
+ | String
|
-Specifies the image status. The value can be one of the following:
-- queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
- saving: indicates that the image file is being uploaded to the backend storage.
- deleted: indicates that the image has been deleted.
- killed: indicates that an error occurs on the image uploading.
- active: indicates that the image is available for use.
+ | Specifies the image status. The value can be:
+- 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
|
-No
+ | No
|
-String
+ | String
|
Specifies the image name. Exact matching is used. For detailed description, see Image Attributes.
|
container_format
|
-No
+ | No
|
-String
+ | String
|
-Specifies the container type. The value is bare.
+ | Specifies the container type. The value is bare.
|
disk_format
|
-No
+ | No
|
-String
+ | String
|
-Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.
+ | Specifies the image format. The value can be zvhd2, vhd, zvhd, raw, or qcow2. The default value is zvhd2.
|
min_ram
|
-No
+ | No
|
-Integer
+ | Integer
|
-Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.
+ | Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.
|
min_disk
|
-No
+ | No
|
-Integer
+ | Integer
|
Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.
|
__os_bit
|
-No
+ | No
|
-String
+ | String
|
Specifies the OS architecture, 32 bit or 64 bit.
|
__platform
|
-No
+ | No
|
-String
+ | String
|
-Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
+ | Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
|
marker
|
-No
+ | No
|
-String
+ | String
|
Specifies the start number from which images are queried. The value is the image ID.
|
limit
|
-No
+ | No
|
-Integer
+ | Integer
|
-Specifies the number of images to be queried. The value is an integer and is 500 by default.
+ | Specifies the number of images to be queried. The value is an integer and is 500 by default.
|
sort_key
|
-No
+ | No
|
-String
+ | String
|
-Specifies the field for sorting the query results. The value can be an attribute of the image: name, container_format, disk_format, status, id, size, or created_at. The default value is created_at.
+ | Specifies the field for sorting the query results. The value can be an attribute of the image: name, container_format, disk_format, status, id, size, or created_at. The default value is created_at.
|
sort_dir
|
-No
+ | No
|
-String
+ | String
|
-Specifies whether the query results are sorted in ascending or descending order. Its value can be desc (default) or asc. This parameter is used together with parameter sort_key. The default value is desc.
+ | Specifies whether the query results are sorted in ascending or descending order. Its value can be desc (default) or asc. This parameter is used together with parameter sort_key. The default value is desc.
|
__os_type
|
-No
+ | No
|
-String
+ | String
|
Specifies the image OS type. Available values include:
@@ -214,155 +214,155 @@
|
tag
|
-No
+ | No
|
-String
+ | String
|
Specifies a tag added to an image. Tags can be used as a filter to query images.
- NOTE: The tagging function has been upgraded. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key=Value". For example, an existing tag is a.b. After the tag function upgrade, query the tag using "tag=a=b".
+ NOTE: The tagging function has been upgraded. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key=Value". For example, an existing tag is a.b. After the tag function upgrade, query the tag using "tag=a=b".
|
member_status
|
-No
+ | No
|
-String
+ | String
|
-Specifies the member status. The value can be accepted, rejected, or pending. accepted: indicates that the shared image is accepted. rejected indicates that the image shared by others is rejected. pending indicates that the image shared by others needs to be confirmed. To use this parameter, set visibility to shared during the query.
+ | Specifies the member status. The value can be accepted, rejected, or pending. accepted: indicates that the shared image is accepted. rejected indicates that the image shared by others is rejected. pending indicates that the image shared by others needs to be confirmed. To use this parameter, set visibility to shared during the query.
|
__support_kvm
|
-No
+ | No
|
-String
+ | String
|
-Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.
+ | Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.
|
__support_xen
|
-No
+ | No
|
-String
+ | String
|
-Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.
+ | Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.
|
__support_largememory
|
-No
+ | No
|
-String
+ | String
|
-Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
+ | Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
For the supported OSs, see Table 4.
|
__support_diskintensive
|
-No
+ | No
|
-String
+ | String
|
-Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
+ | Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
|
__support_highperformance
|
-No
+ | No
|
-String
+ | String
|
-Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
+ | Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
|
__support_xen_gpu_type
|
-No
+ | No
|
-String
+ | String
|
-Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+ | Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. See Table 2 for its value. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This parameter cannot co-exist with __support_xen and __support_kvm.
|
__support_kvm_gpu_type
|
-No
+ | No
|
-String
+ | String
|
-Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+ | Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This parameter cannot co-exist with __support_xen and __support_kvm.
|
__support_xen_hana
|
-No
+ | No
|
-String
+ | String
|
-Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen and __support_kvm.
+ | Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
+This parameter cannot co-exist with __support_xen and __support_kvm.
|
__support_kvm_infiniband
|
-No
+ | No
|
-String
+ | String
|
-Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+ | Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
+This parameter cannot co-exist with __support_xen.
|
virtual_env_type
|
-No
+ | No
|
-String
+ | String
|
-Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.
-- For an ECS image (system disk image), the value is FusionCompute.
- For a data disk image, the value is DataImage.
- For a BMS image, the value is Ironic.
- For an ISO image, the value is IsoImage.
+ | Specifies the environment where the image is used. The value can be FusionCompute, Ironic, DataImage, or IsoImage.
+- For an ECS system disk 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.
|
enterprise_project_id
|
-No
+ | No
|
-String
+ | String
|
-Specifies the enterprise project to which the images to be queried belong. - If the value is 0, images of enterprise project default are to be queried.
- If the value is UUID, images of the enterprise project corresponding to the UUID are to be queried.
- If the value is all_granted_eps, images of all enterprise projects are to be queried.
For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
+Specifies the enterprise project to which the images to be queried belong.
|
|
created_at
|
-No
+ | No
|
-String
+ | String
|
-Specifies the time when the image was created. Images can be queried by time. The value is in the format of Operator:UTC time.
+ | Specifies the time when the image was created. 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.
-For example, to query images created before Oct 28, 2018 10:00:00, set the value of created_at as follows:
+The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.
+For example, to query images created before Oct 28, 2018 10:00:00, set the value of created_at as follows:
created_at=lt:2018-10-28T10:00:00Z
|
updated_at
|
-No
+ | No
|
-String
+ | 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.
-For example, to query images updated before Oct 28, 2018 10:00:00, set the value of updated_at as follows:
+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
|
diff --git a/docs/ims/api-ref/en-us_topic_0121671868.html b/docs/ims/api-ref/en-us_topic_0121671868.html
deleted file mode 100644
index 574ed0b7..00000000
--- a/docs/ims/api-ref/en-us_topic_0121671868.html
+++ /dev/null
@@ -1,15 +0,0 @@
-
-
-Calling APIs
-
-
-
diff --git a/docs/ims/api-ref/en-us_topic_0121671869.html b/docs/ims/api-ref/en-us_topic_0121671869.html
deleted file mode 100644
index b8b7a52e..00000000
--- a/docs/ims/api-ref/en-us_topic_0121671869.html
+++ /dev/null
@@ -1,59 +0,0 @@
-
-
-Authentication
-Requests for calling an API can be authenticated using either of the following methods: - Token authentication: Requests are authenticated using tokens.
- AK/SK authentication: Requests are encrypted using AK/SK pairs. AK/SK authentication is recommended because it is more secure than token authentication.
-
- Token Authentication The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
-
- A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. You can obtain a token by calling the Obtaining User Token API.
- A cloud service can be deployed as either a project-level service or global service. - For a project-level service, you need to obtain a project-level token. When you call the API, set auth.scope in the request body to project.
- For a global service, you need to obtain a global token. When you call the API, set auth.scope in the request body to domain.
-
- IMS is a project-level service. When you call the API, set auth.scope in the request body to project.
- {
- "auth": {
- "identity": {
- "methods": [
- "password"
- ],
- "password": {
- "user": {
- "name": "username",
- "password": "********",
- "domain": {
- "name": "domainname"
- }
- }
- }
- },
- "scope": {
- "project": {
- "name": "xxxxxxxx"
- }
- }
- }
-}
- After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
- | POST https://{{endpoint}}/v3/auth/projects
-Content-Type: application/json
-X-Auth-Token: ABCDEFJ....
- |
-
-
-
- AK/SK Authentication AK/SK authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token authentication is recommended.
-
- In AK/SK authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.
- - AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
- SK: secret access key, which is used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.
- In AK/SK authentication, you can use an AK/SK to sign requests based on the signature algorithm or using the signing SDK.
- The signing SDK is only used for signing requests and is different from the SDKs provided by services.
-
-
- Obtaining a Project ID
-ScenariosA project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:
-
-
- Obtain the Project ID by Calling an APIYou can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.
- The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from . For details about API authentication, see Authentication.
- The following is an example response. The value of id is the project ID.
- {
- "projects": [
- {
- "domain_id": "65382450e8f64ac0870cd180d14e684b",
- "is_domain": false,
- "parent_id": "65382450e8f64ac0870cd180d14e684b",
- "name": "project_name",
- "description": "",
- "links": {
- "next": null,
- "previous": null,
- "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
- },
- "id": "a4a5d4098fb4474fa22cd05f897d6b99",
- "enabled": true
- }
- ],
- "links": {
- "next": null,
- "previous": null,
- "self": "https://www.example.com/v3/projects"
- }
-}
-
- Obtain a Project ID from the ConsoleA project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID: - Log in to the management console.
- Click the username and select My Credentials from the drop-down list.
On the My Credentials page, view project IDs in the project list.
-Figure 1 Viewing project IDs
-In multi-project scenarios, expand the region, and obtain your sub-project ID from the Project ID column.
-
-
-
- Making an API Request
-This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.
- Request URIA request URI is in the following format:
- {URI-scheme}://{Endpoint}/{resource-path}?{query-string}
- Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
-
- Table 1 URI parameter descriptionParameter
- |
-Description
- |
-
|---|
-
-URI-scheme
- |
-Protocol used to transmit requests. All APIs use HTTPS.
- |
-
-Endpoint
- |
-Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints.
- |
-
-resource-path
- |
-Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.
- |
-
-query-string
- |
-Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of Parameter name=Parameter value. For example, ? limit=10 indicates that a maximum of 10 data records will be displayed.
- |
-
-
-
-
- To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
-
-
- Request MethodsThe HTTP protocol defines the following request methods that can be used to send a request to the server.
- Table 2 HTTP methodsMethod
- |
-Description
- |
-
|---|
-
-GET
- |
-Requests the server to return specified resources.
- |
-
-PUT
- |
-Requests the server to update specified resources.
- |
-
-POST
- |
-Requests the server to add resources or perform special operations.
- |
-
-DELETE
- |
-Requests the server to delete specified resources, for example, an object.
- |
-
-HEAD
- |
-Same as GET except that the server must return only the response header.
- |
-
-PATCH
- |
-Requests the server to update partial content of a specified resource.
-If the resource does not exist, a new resource will be created.
- |
-
-
-
-
-
- For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
- | POST https://{{endpoint}}/v3/auth/tokens
- |
-
-
-
- Request HeaderYou can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.
- Common request header fields are as follows.
- Table 3 Common request header fieldsParameter
- |
-Description
- |
-Mandatory
- |
-Example Value
- |
-
|---|
-
-Host
- |
-Specifies the server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is in the format of Hostname:Port number. If the port number is not specified, the default port is used. The default port number for https is 443.
- |
-No
-This field is mandatory for AK/SK authentication.
- |
-code.test.com
-or
-code.test.com:443
- |
-
-Content-Type
- |
-Specifies the type (or format) of the message body. The default value application/json is recommended. Other values of this field will be provided for specific APIs if any.
- |
-Yes
- |
-application/json
- |
-
-Content-Length
- |
-Specifies the length of the request body. The unit is byte.
- |
-No
- |
-3495
- |
-
-X-Project-Id
- |
-Specifies the project ID. Obtain the project ID by following the instructions in Obtaining a Project ID.
- |
-No
- |
-e9993fc787d94b6c886cbaa340f9c0f4
- |
-
-X-Auth-Token
- |
-Specifies the user token.
-It is a response to the API for obtaining a user token (This is the only API that does not require authentication).
-After the request is processed, the value of X-Subject-Token in the response header is the token value.
- |
-No
-This field is mandatory for token authentication.
- |
-The following is part of an example token:
-MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
- |
-
-
-
-
-
- In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDKs to sign a request. During the signature, the Authorization (signature authentication) and X-Sdk-Date (time when a request is sent) headers are automatically added in the request.
- For more details, see "Authentication Using AK/SK" in Authentication.
-
- The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:
- | POST https://{{endpoint}}/v3/auth/tokens
-Content-Type: application/json
- |
-
-
-
- (Optional) Request BodyThis part is optional. The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers content except the request header.
- The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
- In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with the actual values. Obtain a project name from Regions and Endpoints.
- The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.
-
- 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 | POST https://{{endpoint}}/v3/auth/tokens
-Content-Type: application/json
-
-{
- "auth": {
- "identity": {
- "methods": [
- "password"
- ],
- "password": {
- "user": {
- "name": "username",
- "password": "********",
- "domain": {
- "name": "domainname"
- }
- }
- }
- },
- "scope": {
- "project": {
- "name": "xxxxxxxxxxxxxxxxxx"
- }
- }
- }
-}
- |
-
-
- If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.
-
-
+- Introduction
+
- Image Management
- Image Tagging
diff --git a/docs/ims/api-ref/en-us_topic_0125866390.html b/docs/ims/api-ref/en-us_topic_0125866390.html
index eed86ae3..6716e649 100644
--- a/docs/ims/api-ref/en-us_topic_0125866390.html
+++ b/docs/ims/api-ref/en-us_topic_0125866390.html
@@ -91,7 +91,7 @@
Registering an Image
|
PUT /v1/cloudimages/{image_id}/upload
- NOTE: Before registering an image file, ensure that you have the Tenant Administrator permission for OBS.
+ NOTE: - Before registering an image file, ensure that you have the Tenant Administrator permission for OBS.
- You have the permissions to use enterprise projects when you register an image only if you select the default enterprise project.
|
ims:images:upload
diff --git a/docs/ims/api-ref/en-us_topic_0133188204.html b/docs/ims/api-ref/en-us_topic_0133188204.html
index f44e3d78..61915ae4 100644
--- a/docs/ims/api-ref/en-us_topic_0133188204.html
+++ b/docs/ims/api-ref/en-us_topic_0133188204.html
@@ -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.
|
@@ -229,7 +229,7 @@
String
|
Specifies the enterprise project to which the image belongs.
- |
diff --git a/docs/ims/api-ref/en-us_topic_0170155703.html b/docs/ims/api-ref/en-us_topic_0170155703.html
deleted file mode 100644
index 629b29d1..00000000
--- a/docs/ims/api-ref/en-us_topic_0170155703.html
+++ /dev/null
@@ -1,66 +0,0 @@
-
-
-Response
-Status CodeAfter sending a request, you will receive a response, including a status code, response header, and response body.
- A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Codes.
- For example, if status code 201 is returned for calling the API used to , the request is successful.
-
- Response HeaderSimilar to a request, a response also has a header, for example, Content-Type.
- Figure 1 shows the response header fields for the API used to . The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
- Figure 1 Header fields of the response to the request for obtaining a user token
-
- (Optional) Response BodyThe body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.
-
- The following is part of the response body for the API used to .
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12 | {
- "token": {
- "expires_at": "2019-02-13T06:52:13.855000Z",
- "methods": [
- "password"
- ],
- "catalog": [
- {
- "endpoints": [
- {
- "region_id": "az-01",
-......
- |
-
-
- If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
- | {
- "error_msg": "The format of message is error",
- "error_code": "AS.0001"
-}
- |
-
-
- In the response body, error_code is an error code, and error_msg provides information about the error.
- Introduction
+This section describes fine-grained permissions management for your IMS. If your account does not need individual IAM users, you may skip over this section.
+ By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign policies or roles to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user can perform specified operations on cloud services based on the permissions.
+ You can grant user permissions by using roles and policies.
+ - Roles: A type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. This mechanism provides only a limited number of service-level roles for authorization.
- Policies: A type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This mechanism allows for API-level policies for authorization, meeting requirements for secure access control.
+ Policy-based authorization is useful if you want to allow or deny the access to an API.
+
+ An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user queries images using an API, the user must have been granted permissions that allow the ims:images:list action.
+ Supported ActionsIMS provides system-defined policies. You can also create custom policies for more specific access control. The following are related concepts:
+ - Permissions: Allow or deny certain operations.
- APIs: APIs that will be called for performing certain operations.
- Actions: Operations that will be allowed or denied.
- Dependent actions: When assigning permissions for an action, you also need to assign permissions for the dependent actions.
- IAM projects or enterprise projects: Applicable scope of custom policies. For example, if an action supports both IAM and enterprise projects, the policy that contains this action will take effect for user groups assigned in IAM and Enterprise Management. If an action supports only IAM projects, the policy will take effect only for user groups assigned in IAM.
+ √: supported; x: not supported
+
+ IMS supports the following actions that can be defined in custom policies:
+ - Image Management, including actions supported by IMS's image management APIs, such as the APIs for querying images, updating image information, creating images, registering images, and exporting images.
- Image Tagging, including actions supported by IMS's tag management APIs, such as the APIs for adding tags, deleting tags, and querying images.
- Image Schema, including actions supported by IMS's image schema management APIs, such as the APIs for querying an image schema, querying an image list schema, querying an image member schema, and query an image member list schema.
- Image Sharing, including actions supported by IMS's shared image APIs, such as the APIs for adding an image member, updating the status of image members, querying image member details, and deleting an image member.
- Image Replication, including actions supported by IMS's image replication APIs, such as the API for replicating an image within a region.
- Image Quota, including actions supported by IMS's image quota APIs, such as the API for querying image quotas.
+ Error messages returned for native OpenStack APIs are in XML format. JSON format of the fine-grained policy is not supported.
+
+
+ | |
|---|
|
|---|
|
|---|
|
|---|
|