diff --git a/docs/ims/api-ref/ALL_META.TXT.json b/docs/ims/api-ref/ALL_META.TXT.json index 4d061fee5..9f756670f 100644 --- a/docs/ims/api-ref/ALL_META.TXT.json +++ b/docs/ims/api-ref/ALL_META.TXT.json @@ -64,7 +64,7 @@ "node_id":"en-us_topic_0020091565.xml", "product_code":"ims", "code":"4", - "des":"This API is used to query images using search criteria and to display the images in a list.GET /v2/cloudimages{?__isregistered,__imagetype,__whole_image,__system__cmkid,p", + "des":"This API is used to query images using search criteria and to display the images in a list.GET /v2/cloudimagesYou can type a question mark (?) and an ampersand (&) at the", "doc_type":"api", "kw":"Querying Images,Image,API Reference", "search_title":"", @@ -161,7 +161,7 @@ "code":"9", "des":"This API is used to create a full-ECS image from an ECS, Cloud Server Backup Service (CSBS) backup, or Cloud Backup and Recovery (CBR) backup. The API is an asynchronous ", "doc_type":"api", - "kw":"SAN policies,Creating a Full-ECS Image,Image,API Reference", + "kw":"Creating a Full-ECS Image,Image,API Reference", "search_title":"", "metedata":[ { @@ -254,7 +254,7 @@ "node_id":"en-us_topic_0067360382.xml", "product_code":"ims", "code":"14", - "des":"This API is used to query image tags using search criteria and display them in a list.GET /v1/cloudimages/tags{?__isregistered,__imagetype,__whole_image,__system__cmkid,p", + "des":"This API is used to query image tags using search criteria and display them in a list.GET /v1/cloudimages/tagsYou can type a question mark (?) and an ampersand (&) at the", "doc_type":"api", "kw":"Querying Tags,Image Tagging,API Reference", "search_title":"", @@ -1090,7 +1090,7 @@ "node_id":"en-us_topic_0170918588.xml", "product_code":"ims", "code":"58", - "des":"This API is used to query a specified API version, such as version compatibility and domain name information of an API.GET /{api_version}Table 1 lists the parameters in t", + "des":"This API is used to query a specified API version, such as version compatibility and domain name information of an API.GET /{version}Table 1 lists the parameters in the U", "doc_type":"api", "kw":"Querying an API Version (Native OpenStack API),API Version Query (Native OpenStack API),API Referenc", "search_title":"", diff --git a/docs/ims/api-ref/CLASS.TXT.json b/docs/ims/api-ref/CLASS.TXT.json index 65473c14f..273bd1535 100644 --- a/docs/ims/api-ref/CLASS.TXT.json +++ b/docs/ims/api-ref/CLASS.TXT.json @@ -27,7 +27,7 @@ "code":"3" }, { - "desc":"This API is used to query images using search criteria and to display the images in a list.GET /v2/cloudimages{?__isregistered,__imagetype,__whole_image,__system__cmkid,p", + "desc":"This API is used to query images using search criteria and to display the images in a list.GET /v2/cloudimagesYou can type a question mark (?) and an ampersand (&) at the", "product_code":"ims", "title":"Querying Images", "uri":"en-us_topic_0020091565.html", @@ -117,7 +117,7 @@ "code":"13" }, { - "desc":"This API is used to query image tags using search criteria and display them in a list.GET /v1/cloudimages/tags{?__isregistered,__imagetype,__whole_image,__system__cmkid,p", + "desc":"This API is used to query image tags using search criteria and display them in a list.GET /v1/cloudimages/tagsYou can type a question mark (?) and an ampersand (&) at the", "product_code":"ims", "title":"Querying Tags", "uri":"en-us_topic_0067360382.html", @@ -513,7 +513,7 @@ "code":"57" }, { - "desc":"This API is used to query a specified API version, such as version compatibility and domain name information of an API.GET /{api_version}Table 1 lists the parameters in t", + "desc":"This API is used to query a specified API version, such as version compatibility and domain name information of an API.GET /{version}Table 1 lists the parameters in the U", "product_code":"ims", "title":"Querying an API Version (Native OpenStack API)", "uri":"en-us_topic_0170918588.html", diff --git a/docs/ims/api-ref/en-us_topic_0020091562.html b/docs/ims/api-ref/en-us_topic_0020091562.html index 5d36c82ef..ca0e46ba6 100644 --- a/docs/ims/api-ref/en-us_topic_0020091562.html +++ b/docs/ims/api-ref/en-us_topic_0020091562.html @@ -58,7 +58,9 @@

String

-

Specifies the image status. The value can be active, queued, saving, deleted, or killed. An image can be used only when it is in the active state.

+

Specifies the image status.

+

The value can be:

+

tags

@@ -145,14 +147,14 @@

String

Provides supplementary information about the image.

-

The value contains a maximum of 1024 characters, including letters and digits. Carriage returns and angle brackets (< >) are not allowed.

+

The value contains a maximum of 1,024 characters, including letters and digits. Carriage returns and angle brackets (< >) are not allowed.

disk_format

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

@@ -282,7 +284,7 @@

String

-

Specifies the ECS boot mode. The following values are supported:

+

Specifies the ECS boot mode. The value can be:

@@ -304,21 +306,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

@@ -341,7 +343,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

@@ -349,7 +351,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

diff --git a/docs/ims/api-ref/en-us_topic_0020091565.html b/docs/ims/api-ref/en-us_topic_0020091565.html index 0385afbde..d4db9862f 100644 --- a/docs/ims/api-ref/en-us_topic_0020091565.html +++ b/docs/ims/api-ref/en-us_topic_0020091565.html @@ -3,7 +3,7 @@

Querying Images

Function

This API is used to query images using search criteria and to display the images in a list.

-

URI

GET /v2/cloudimages{?__isregistered,__imagetype,__whole_image,__system__cmkid,protected,visibility,owner,id,status,name,container_format,disk_format,min_ram,min_disk,__os_bit,__platform,marker,limit,sort_key,sort_dir,__os_type,tag,member_status,__support_kvm,__support_xen,__support_largememory,__support_diskintensive,__support_highperformance,__support_xen_gpu_type,__support_kvm_gpu_type,__support_xen_hana,__support_kvm_infiniband,virtual_env_type,enterprise_project_id,created_at,updated_at}

+

URI

GET /v2/cloudimages

You can type a question mark (?) and an ampersand (&) at the end of the URI to define multiple search criteria. For details, see the example request.

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

@@ -190,7 +190,11 @@

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:

+
  • name: image name
  • container_format: container type
  • disk_format: image format
  • status: image status
  • id: image ID
  • size: unavailable value now
  • created_at: image creation time
+

Default value:

+

created_at

sort_dir

@@ -199,7 +203,7 @@

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

@@ -256,7 +260,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 +271,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 +280,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 +298,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 +308,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 +318,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 +362,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 +463,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 +555,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 +606,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 +678,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 +721,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

@@ -765,7 +769,7 @@

String

Specifies whether the image supports password/private key injection using Cloud-Init.

-

If the value is set to true, password/private key injection using Cloud-Init is not supported.

+

true indicates password/private key injection using Cloud-Init is not supported. Other values indicate the injection is supported.

NOTE:

This parameter is valid only for ECS system disk images.

@@ -774,7 +778,7 @@

String

-

Specifies the ECS boot mode. Available values include:

+

Specifies the ECS boot mode. The value can be:

  • bios indicates the BIOS boot mode.
  • uefi indicates the UEFI boot mode.
diff --git a/docs/ims/api-ref/en-us_topic_0020091566.html b/docs/ims/api-ref/en-us_topic_0020091566.html index 14b145015..34de8c81b 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,14 +436,14 @@

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.

diff --git a/docs/ims/api-ref/en-us_topic_0020091567.html b/docs/ims/api-ref/en-us_topic_0020091567.html index 0b4828204..c1c84d8f2 100644 --- a/docs/ims/api-ref/en-us_topic_0020091567.html +++ b/docs/ims/api-ref/en-us_topic_0020091567.html @@ -43,7 +43,7 @@ -

[Array]

+

[Array]

Yes

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

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

@@ -452,14 +452,14 @@

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

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

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

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

@@ -524,7 +524,7 @@

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.

__support_kvm_hi1822_hisriov

diff --git a/docs/ims/api-ref/en-us_topic_0020092109.html b/docs/ims/api-ref/en-us_topic_0020092109.html index 15d136946..bd875fb8a 100644 --- a/docs/ims/api-ref/en-us_topic_0020092109.html +++ b/docs/ims/api-ref/en-us_topic_0020092109.html @@ -3,10 +3,10 @@

Creating an Image

Function

This API is used to create a private image. The following methods are supported:

  • Create a system or data disk image from an ECS.
  • Create a system disk image from an external image file uploaded to an OBS bucket.
  • Create a system disk image from a data disk.
-

The API is an asynchronous one. If it is successfully called, the cloud service system receives the request. However, you need to use the asynchronous job query API to query the image creation status. For details, see Querying the Status of an Asynchronous Job.

+

This API is asynchronous. A successful call only means the cloud service system has received the request. To see if an image is created successfully, 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, you need to initialize the source VM to ensure the image availability. For details, 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, you need to initialize the source VM to ensure the image availability. For details, 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

@@ -23,11 +23,13 @@

name

-

Yes

+

No

String

Specifies the name of the system disk image. For detailed description, see Image Attributes.

+
NOTICE:

This parameter is mandatory when you use a cloud server to create a system disk image.

+

description

@@ -41,13 +43,15 @@

instance_id

-

Yes

+

No

String

Specifies the ID of the ECS used to create the image.

To obtain the ECS ID, perform the following operations:

-
  1. Log in to management console.
  2. Under Computing, click Elastic Cloud Server.
  3. In the ECS list, click the name of the ECS and view its ID.
+
  1. Log in to the management console.
  2. Under Computing, click Elastic Cloud Server.
  3. In the ECS list, click the name of the ECS and view its ID.
+
NOTICE:

This parameter is mandatory when you use a cloud server to create a system disk image.

+

data_images

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

For details about image_tags, see Table 3.

@@ -212,7 +216,8 @@

Specifies the OS version.

This parameter is valid if an external image file uploaded to the OBS bucket is used to create an image. For its value, see Values of Related Parameters.

-
NOTE:

This parameter is mandatory when the value of is_quick_import is true, that is, a system disk image is imported using the quick import method.

+
NOTE:

If the uploaded file is in ISO format, this parameter is mandatory.

+

This parameter is mandatory when the value of is_quick_import is true, that is, a system disk image is imported using the quick import method.

@@ -224,9 +229,9 @@

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.

-
  • To obtain an OBS bucket name:
    1. Log in to the management console and choose Storage > Object Storage Service.

      All OBS buckets are displayed in the list.

      +
      • To obtain an OBS bucket name:
        1. Log in to the management console.
        2. In the service list, choose Storage > Object Storage Service.

          All OBS buckets are displayed in the list.

        3. Filter the OBS buckets by region and locate the target bucket in the current region.
        -
      • To obtain an OBS image file name:
        1. Log in to the management console and choose Storage > Object Storage Service.

          All OBS buckets are displayed in the list.

          +
        2. To obtain an OBS image file name:
          1. Log in to the management console.
          2. In the service list, choose Storage > Object Storage Service.

            All OBS buckets are displayed in the list.

          3. Filter the OBS buckets by region and locate the target bucket in the current region.
          4. Click the name of the target bucket to go to the bucket details page.
          5. In the navigation pane on the left, choose Objects to display objects in the OBS bucket and then locate the external image file used to create an image.
      NOTE:

      The storage class of the OBS bucket must be Standard.

      @@ -251,7 +256,7 @@

      Specifies whether automatic configuration is enabled.

      The value can be true or false.

      -

      If automatic configuration is required, set the value to true. Otherwise, set the value to false The default value is false.

      +

      If automatic configuration is required, set the value to true. Otherwise, set it to false. The default value is false.

      For details about automatic configuration, see Creating a Linux System Disk Image from an External Image File > Registering an External Image File as a Private Image (Linux) in Image Management Service User Guide.

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

      For details about image_tags, see Table 3.

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

        @@ -321,7 +326,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

        @@ -403,9 +408,9 @@

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

        The format is OBS bucket name:Image file name.

        -
        • To obtain an OBS bucket name:
          1. Log in to the management console and choose Storage > Object Storage Service.

            All OBS buckets are displayed in the list.

            +
            • To obtain an OBS bucket name:
              1. Log in to the management console.
              2. In the service list, choose Storage > Object Storage Service.

                All OBS buckets are displayed in the list.

              3. Filter the OBS buckets by region and locate the target bucket in the current region.
              -
            • To obtain an OBS image file name:
              1. Log in to the management console and choose Storage > Object Storage Service.

                All OBS buckets are displayed in the list.

                +
              2. To obtain an OBS image file name:
                1. Log in to the management console.
                2. In the service list, choose Storage > Object Storage Service.

                  All OBS buckets are displayed in the list.

                3. Filter the OBS buckets by region and locate the target bucket in the current region.
                4. Click the name of the target bucket to go to the bucket details page.
                5. In the navigation pane on the left, choose Objects to display objects in the OBS bucket and then locate the external image file used to create an image.
            NOTE:

            The storage class of the OBS bucket must be Standard.

            @@ -442,7 +447,7 @@

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

            For detailed parameter descriptions, see Image Tag Format.

            -

            Use either tags or image_tags.

            +

            Use either tags or image_tags.

            image_tags

            @@ -551,7 +556,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

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

            For details about image_tags, see Table 3.

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

              @@ -616,7 +621,7 @@

              Example Request

              • Creating a system disk image with parameter tags using an ECS (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
                POST https://{Endpoint}/v2/cloudimages/action
                 {
                     "name": "ims_test",
                -       "description": "Create a system disk image from an ECS",
                +    "description": "Create a system disk image from an ECS",
                     "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
                     "tags": [
                         "aaa.111",
                @@ -664,7 +669,7 @@
                 13
              POST https://{Endpoint}/v2/cloudimages/action
               {
                     "name": "ims_test_file",
              -  "description": "Create an image from a file in an OBS bucket",
              +      "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,
              @@ -729,6 +734,26 @@
               }
               
            +
          2. Creating an image with parameter tags using an ISO file in an OBS bucket (file address in the bucket: ims-image:centos70.iso)
            POST https://{Endpoint}/v2/cloudimages/action
            +{
            +    "name": "ims_test_file",
            +    "min_disk": 40,
            +    "image_url": "ims-image:centos70.iso",
            +    "description": "Create an image from an ISO file",
            +    "type": "IsoImage",
            +    "os_version": "CentOS 7.0 64bit",
            +    "tags": ["aaa.111", "bbb.333", "ccc.444"]
            +}
            +
          3. Creating an image with parameter image_tags using an ISO file in an OBS bucket (file address in the bucket: ims-image:centos70.iso)
            POST https://{Endpoint}/v2/cloudimages/action
            +{
            +    "name": "ims_test_file",
            +    "min_disk": 40,
            +    "image_url": "ims-image:centos70.iso",
            +    "description": "Create an image from an ISO file",
            +    "type": "IsoImage",
            +    "os_version": "CentOS 7.0 64bit",
            +    "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}]
            +}
          4. Creating a system disk image with parameter tags using a data disk (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)
             1
              2
              3
            diff --git a/docs/ims/api-ref/en-us_topic_0022473688.html b/docs/ims/api-ref/en-us_topic_0022473688.html
            index b7ad5b00e..ca4aaf97c 100644
            --- a/docs/ims/api-ref/en-us_topic_0022473688.html
            +++ b/docs/ims/api-ref/en-us_topic_0022473688.html
            @@ -113,7 +113,7 @@
             
            -
            Table 2 Data structure description of the entities field

            Parameter

            +
            @@ -130,13 +130,6 @@
            • imsCreateImageByInstance
            • imsImportImageJob
            • imsVolumeCreateImageJob
            • imsImportDataImageJob
            • imsCreateWholeImageByInstanceJob
            • imsCreateWholeImageByBackupJob
            • imsNativeImportImageJob
            • imsNativeExportImageJob
            • imsCopyImageInRegionJob
            - - - - - - - - -
            Table 2 Data structure description of the entities field

            Parameter

            Type

            current_task

            -

            String

            -

            Specifies the job name.

            -

            image_name

            String

            @@ -144,13 +137,6 @@

            Specifies the image name.

            process_percent

            -

            Double

            -

            Specifies the job progress.

            -

            results

            Array of result objects

            @@ -204,14 +190,16 @@

            String

            Specifies the job status.

            +

            Specifies the job status.

            +

            The value can be:

            +
            • SUCCESS: The job is successfully executed.
            • FAIL: The job failed to be executed.
            • RUNNING: The job is in progress.
            • INIT: The job is being initialized.
            -
            Table 4 Data structure description of the sub_jobs_result field

            Parameter

            +
            @@ -224,7 +212,7 @@ -
            Table 4 Data structure description of the sub_jobs_result field

            Parameter

            Type

            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

            @@ -238,7 +226,16 @@

            String

            Specifies the sub-job type.

            +

            Specifies the sub-job type.

            +

            The value can be:

            +

            imsGoofysImportImageJob: importing an image

            +

            imsGoofysImportImageWithoutconfigJob: importing an image

            +

            imsGoofysUploadImageJob: importing an image

            +

            imsGoofysExportImageJob: exporting an image

            +

            imsImportBigFileImageJob: importing an image

            +

            imsQuickExportImageJob: fast export of an image

            +

            imsImportIsoFileImageJob: creating an ISO image

            +

            imsImportDataImageJob: creating a data disk image

            begin_time

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

            Response

            • Response parameters -
            Table 5 Data structure description of the sub_jobs_result.entities field

            Parameter

            +
            diff --git a/docs/ims/api-ref/en-us_topic_0022473689.html b/docs/ims/api-ref/en-us_topic_0022473689.html index e5b31024f..781d05fc7 100644 --- a/docs/ims/api-ref/en-us_topic_0022473689.html +++ b/docs/ims/api-ref/en-us_topic_0022473689.html @@ -147,7 +147,7 @@ - @@ -422,7 +422,7 @@ - @@ -1402,7 +1402,7 @@ - @@ -1919,9 +1919,9 @@ - - - + + + @@ -110,7 +118,7 @@ - @@ -245,7 +253,7 @@ - diff --git a/docs/ims/api-ref/en-us_topic_0031615565.html b/docs/ims/api-ref/en-us_topic_0031615565.html index 344a63138..22d5e10cb 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 @@ - - - - -
            Table 5 Data structure description of the sub_jobs_result.entities field

            Parameter

            Type

            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 600699aac..45b929be5 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 @@

            2024-08-15

            +

            2025-11-6

            +

            Modified the following content:

            +

            Added parameter descriptions and API examples in Creating an Image.

            +

            Deleted the query parameter from the URI in Querying Images.

            +

            Updated the query parameter in the URI in Querying Tags.

            +

            2024-08-15

            Modified the following content:

            Modified the Red Hat version in Values of Related Parameters.

            @@ -79,7 +87,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

            @@ -223,7 +231,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

            @@ -71,7 +71,7 @@

            String

            Specifies the image format. The value can be zvhd2, vhd, raw, or qcow2. The default value is zvhd2.

            +

            Specifies the image format. The value can be zvhd2, vhd, raw, or qcow2. The default value is zvhd2.

            tags

            @@ -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,14 +161,14 @@

            String

            Specifies the container format.

            -

            The value is bare.

            +

            The value is bare.

            disk_format

            String

            Specifies the image format. The value can be zvhd2, vhd, raw, or qcow2. The default value is zvhd2.

            +

            Specifies the image format. The value can be zvhd2, vhd, raw, or qcow2. The default value is zvhd2.

            tags

            @@ -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_0031615566.html b/docs/ims/api-ref/en-us_topic_0031615566.html index c8d9fcfa3..2be655eaf 100644 --- a/docs/ims/api-ref/en-us_topic_0031615566.html +++ b/docs/ims/api-ref/en-us_topic_0031615566.html @@ -32,7 +32,7 @@
            -

            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.

            +
            • 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.
            • API Gateway checks the time format and compares the request time with the time when API Gateway received the request. If the time difference exceeds 15 minutes, API Gateway will reject the request. So, the local time on the client must be synchronized with the clock server to avoid a large offset in the value of X-Sdk-Date in the request header.

            Request

            • Request parameters diff --git a/docs/ims/api-ref/en-us_topic_0036994316.html b/docs/ims/api-ref/en-us_topic_0036994316.html index ded42b06e..04fdf536f 100644 --- a/docs/ims/api-ref/en-us_topic_0036994316.html +++ b/docs/ims/api-ref/en-us_topic_0036994316.html @@ -3,7 +3,7 @@

              Restrictions on Image Sharing

              Description

              You can use the image sharing function to share your private images with other users.

              -

              Constraints

              • Images can only be shared within a region.
              • A system disk image or data disk image can be shared with a maximum of 256 tenants, and a full-ECS image can be shared with a maximum of 10 tenants.
              • You can stop sharing images anytime without notifying the recipients.
              • An image shared with a domain or an OU cannot be deleted. Other shared images can be deleted anytime without notifying the recipients.
              • Encrypted images cannot be shared.
              • Only full-ECS images created from CBR backups can be shared. Full-ECS images created using other methods cannot be shared.
              +

              Constraints

              • Images can only be shared within a region.
              • A system disk image or data disk image can be shared with a maximum of 256 tenants, and a full-ECS image can be shared with a maximum of 10 tenants.
              • You can stop sharing images anytime without notifying the recipients.
              • An image shared with a domain or an OU cannot be deleted. Other shared images can be deleted anytime without notifying the recipients.
              • An image encrypted using the default key cannot be shared with other users.
              • Only full-ECS images created from CBR backups can be shared. Full-ECS images created using other methods cannot be shared.
              diff --git a/docs/ims/api-ref/en-us_topic_0036994319.html b/docs/ims/api-ref/en-us_topic_0036994319.html index 66ca41185..4077d0bbd 100644 --- a/docs/ims/api-ref/en-us_topic_0036994319.html +++ b/docs/ims/api-ref/en-us_topic_0036994319.html @@ -58,6 +58,8 @@

            String

            Specifies the image sharing status.

            +

            The value can be:

            +
            • accepted: The shared image is accepted. After you accept an image, the image will be displayed in your image list. You can use the image to create cloud servers.
            • rejected: The shared image is rejected. After you reject an image, the image will disappear from your image list, but you can still use the image to create cloud servers.

            created_at

            diff --git a/docs/ims/api-ref/en-us_topic_0049147856.html b/docs/ims/api-ref/en-us_topic_0049147856.html index f3969f9b7..248954f0e 100644 --- a/docs/ims/api-ref/en-us_topic_0049147856.html +++ b/docs/ims/api-ref/en-us_topic_0049147856.html @@ -59,7 +59,7 @@

            String

            Provides supplementary information about the image. For detailed description, see Image Attributes. The value contains a maximum of 1024 characters, including letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.

            +

            Provides supplementary information about the image. For detailed description, see Image Attributes. The value contains a maximum of 1,024 characters, including letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.

            cmk_id

            diff --git a/docs/ims/api-ref/en-us_topic_0060804959.html b/docs/ims/api-ref/en-us_topic_0060804959.html index fd87c2f9b..2ba0ef949 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

            @@ -185,7 +185,7 @@

            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

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

            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

            diff --git a/docs/ims/api-ref/en-us_topic_0060804960.html b/docs/ims/api-ref/en-us_topic_0060804960.html index 84b6a9c07..756a80b6e 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.

              -
              Table 2 v2.1 request message body

              Parameter

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

              Parameter

              Mandatory

              +

              Mandatory

              Type

              [Array]

              +

              [Array]

              Yes

              Type

              Mandatory

              +

              Mandatory

              Description

              -
              Table 4 v2.0 request message body

              Parameter

              +
              - @@ -111,7 +111,7 @@ - @@ -128,7 +128,7 @@ - @@ -161,7 +161,7 @@ - @@ -210,7 +210,7 @@

              Response

              • Response parameters -
              Table 4 v2.0 request message body

              Parameter

              Mandatory

              +

              Mandatory

              Type

              [Array]

              +

              [Array]

              Yes

              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.

              Parameter

              +
              @@ -357,7 +357,7 @@ - diff --git a/docs/ims/api-ref/en-us_topic_0067360382.html b/docs/ims/api-ref/en-us_topic_0067360382.html index 93ca76427..5ea8a6681 100644 --- a/docs/ims/api-ref/en-us_topic_0067360382.html +++ b/docs/ims/api-ref/en-us_topic_0067360382.html @@ -3,7 +3,7 @@

              Querying Tags

              Function

              This API is used to query image tags using search criteria and display them in a list.

              -

              URI

              GET /v1/cloudimages/tags{?__isregistered,__imagetype,__whole_image,__system__cmkid,protected,visibility,owner,id,status,name,container_format,disk_format,min_ram,min_disk,__os_bit,__platform,marker,limit,sort_key,sort_dir,__os_type,tag,member_status,__support_kvm,__support_xen,__support_largememory,__support_diskintensive,__support_highperformance,__support_xen_gpu_type,__support_kvm_gpu_type,__support_xen_hana,__support_kvm_infiniband,virtual_env_type,enterprise_project_id,created_at,updated_at}

              +

              URI

              GET /v1/cloudimages/tags

              You can type a question mark (?) and an ampersand (&) at the end of the URI to define multiple search criteria. For details, see the example request.

              @@ -190,7 +190,11 @@
              - - diff --git a/docs/ims/api-ref/en-us_topic_0083905788.html b/docs/ims/api-ref/en-us_topic_0083905788.html index 584bdcda7..71158dfd1 100644 --- a/docs/ims/api-ref/en-us_topic_0083905788.html +++ b/docs/ims/api-ref/en-us_topic_0083905788.html @@ -32,7 +32,7 @@ @@ -236,7 +204,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

              @@ -633,7 +633,7 @@

              String

              Specifies the agents configured for the image.

              -
              • hss: server security

                Host Security Service (HSS) helps you identify and manage the assets on your servers, eliminate risks, and defend against intrusions and web page tampering. There are also advanced protection and security operations functions available to help you easily detect and handle threats.

                +
                • hss: server security

                  Host Security Service (HSS) helps you identify and manage the assets on your servers, eliminate risks, and defend against intrusions and web page tampering. There are also advanced protection and security operations available to help you easily detect and handle threats.

                • ces: The host monitoring agent is configured for the image.

                  Monitoring is key for ensuring ECS performance, reliability, and availability. Using monitored data, you can determine ECS resource utilization. The cloud platform provides Cloud Eye to help you obtain the running statuses of your ECSs. You can use Cloud Eye to automatically monitor ECSs in real time and manage alarms and notifications to keep track of ECS performance metrics.

                Example:

                diff --git a/docs/ims/api-ref/en-us_topic_0066978719.html b/docs/ims/api-ref/en-us_topic_0066978719.html index 0a95e8759..6735a692c 100644 --- a/docs/ims/api-ref/en-us_topic_0066978719.html +++ b/docs/ims/api-ref/en-us_topic_0066978719.html @@ -45,6 +45,8 @@

              String

              Specifies the API status.

              +

              The value can be:

              +
              • CURRENT: This is the preferred API version.
              • SUPPORTED: This is an old but still available API version.
              • DEPRECATED: This is a deprecated API version that will be removed.

              id

              diff --git a/docs/ims/api-ref/en-us_topic_0067360381.html b/docs/ims/api-ref/en-us_topic_0067360381.html index 548c16cd1..23e8a1600 100644 --- a/docs/ims/api-ref/en-us_topic_0067360381.html +++ b/docs/ims/api-ref/en-us_topic_0067360381.html @@ -43,7 +43,7 @@

              Object

              Lists the image tags. For detailed description, see Image Tag Format. This parameter is left blank by default.

              -

              Use either tag or image_tag.

              +

              Use either tag or image_tag.

              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:

              +
              • name: image name
              • container_format: container type
              • disk_format: image format
              • status: image status
              • id: image ID
              • size: unavailable value now
              • created_at: image creation time
              +

              Default value:

              +

              created_at

              sort_dir

              @@ -199,7 +203,7 @@

              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

              @@ -361,7 +365,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

              String

              Provides supplementary information about the image.

              -

              For detailed description, see Image Attributes. The value contains a maximum of 1024 characters, including letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.

              +

              For detailed description, see Image Attributes. The value contains a maximum of 1,024 characters, including letters and digits. Carriage returns and angle brackets (< >) are not allowed. This parameter is left blank by default.

              os_type

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

              diff --git a/docs/ims/api-ref/en-us_topic_0092380109.html b/docs/ims/api-ref/en-us_topic_0092380109.html index 29f268d78..0ee8874e2 100644 --- a/docs/ims/api-ref/en-us_topic_0092380109.html +++ b/docs/ims/api-ref/en-us_topic_0092380109.html @@ -3,41 +3,9 @@

              Creating a Full-ECS Image

              Function

              This API is used to create a full-ECS image from an ECS, Cloud Server Backup Service (CSBS) backup, or Cloud Backup and Recovery (CBR) backup. The API is an asynchronous one. If it is successfully called, the cloud system receives the request to create a full-ECS image. 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 (Creating a Full-ECS Image from an ECS)

              • When creating a full-ECS image from an ECS, ensure that the ECS has been properly configured, or the image creation may fail.
              • A Windows ECS used to create a full-ECS image cannot have a spanned volume, or data may be lost when ECSs are created from that image.
              • A Linux ECS used to create a full-ECS image cannot have a disk group or logical disk that contains multiple physical disks, or data may be lost when ECSs are created from that image.
              • A full-ECS image cannot be exported or replicated.
              • When creating a full-ECS image from a Windows ECS, you need to change the SAN policy of the ECS to OnlineAll. Otherwise, EVS disks attached to the ECSs created from the image may be offline.

                Windows has three types of SAN policies: OnlineAll, OfflineShared, and OfflineInternal.

                - -
                - - - - - - - - - - - - - -
                Table 1 SAN policies in Windows

                Type

                -

                Description

                -

                OnlineAll

                -

                All newly detected disks are automatically brought online.

                -

                OfflineShared

                -

                All disks on sharable buses, such as iSCSI and FC, are left offline by default, while disks on non-sharable buses are kept online.

                -

                OfflineInternal

                -

                All newly detected disks are left offline.

                -
                +

                Constraints (Creating a Full-ECS Image from an ECS)

                • When creating a full-ECS image from an ECS, ensure that the ECS has been properly configured, or the image creation may fail.
                • A Windows ECS used to create a full-ECS image cannot have a spanned volume, or data may be lost when ECSs are created from that image.
                • A Linux ECS used to create a full-ECS image cannot have a physical disk group or a logical disk that contains multiple physical disks, or data may be lost when ECSs are created from that image.
                • A full-ECS image cannot be exported or replicated.
                • When creating a full-ECS image from a Windows ECS, you need to set the SAN policy of the ECS to OnlineAll. Otherwise, EVS disks attached to the ECSs created from the image may be offline. For details, see "Creating a Full-ECS Image from an ECS" > "Setting the ECS SAN Policy to OnlineAll" in Image Management Service User Guide.
                -
                1. Execute cmd.exe and run the following command to query the current SAN policy of the ECS:

                  diskpart

                  -
                2. Run the following command to view the SAN policy of the ECS:
                  san
                  • If the SAN policy is OnlineAll, run the exit command to exit DiskPart.
                  -
                  -
                  • If the SAN policy is not OnlineAll, go to 3.
                  -
                3. Run the following command to change the SAN policy of the ECS to OnlineAll:

                  san policy=onlineall

                  -
                -
              -
              -

              Constraints (Creating a Full-ECS Image from 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 from 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 from 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.
              @@ -89,8 +57,8 @@

              Array of objects

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

              -

              Use either tags or image_tags.

              -

              For details about image_tags, see Table 2.

              +

              Use either tags or image_tags.

              +

              For details about image_tags, see Table 1.

              instance_id

              @@ -101,7 +69,7 @@

              Specifies the ECS ID. This parameter is required when an ECS is used to create a full-ECS image.

              To obtain the ECS ID, perform the following operations:

              -
              1. Log in to management console.
              2. Under Computing, click Elastic Cloud Server.
              3. In the ECS list, click the name of the ECS and view its ID.
              +
              1. Log in to the management console.
              2. Under Computing, click Elastic Cloud Server.
              3. In the ECS list, click the name of the ECS and view its ID.

              enterprise_project_id

              @@ -183,7 +151,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

              @@ -194,7 +162,7 @@

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

              Use either tags or image_tags.

              -

              For details about image_tags, see Table 2.

              +

              For details about image_tags, see Table 1.

              backup_id

              @@ -204,9 +172,9 @@

              String

              Specifies the CSBS backup ID or CBR backup ID.

              -
              To obtain the CSBS backup ID, perform the following operations:
              1. Log in to the management console.
              2. Under Storage, click Cloud Server Backup Service.
              3. In the backup list, expand details of the backup to obtain its ID.
              +
              To obtain the CSBS backup ID, perform the following operations:
              1. Log in to the management console.
              2. Under Storage, click Cloud Server Backup Service.
              3. In the backup list, expand details of the backup to obtain its ID.
              -
              To obtain the CBR backup ID, perform the following operations:
              1. Log in to the management console.
              2. Under Storage, click Cloud Backup and Recovery.
              3. On the displayed Cloud Server Backup page, click the Backups tab and obtain the backup ID from the backup list.
              +
              To obtain the CBR backup ID, perform the following operations:
              1. Log in to the management console.
              2. Under Storage, click Cloud Backup and Recovery.
              3. On the displayed Cloud Server Backup page, click the Backups tab and obtain the backup ID from the backup list.

              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

              @@ -254,7 +222,7 @@ -
              Table 2 Data structure of the image_tags field

              Parameter

              +
              @@ -353,7 +321,7 @@ }
              Table 1 Data structure of the image_tags field

              Parameter

              Mandatory

              -
            • Creating a full-ECS image with parameter image_tags using a CSBS backup or CBR backup (ID: 9b27efab-4a17-4c06-bfa2-3e0cf021d3c3)
              1
              +
            • Creating a full-ECS image with parameter image_tags using a CSBS backup or CBR backup (ID: 9b27efab-4a17-4c06-bfa2-3e0cf021d3c3)
              - - diff --git a/docs/ims/api-ref/en-us_topic_0133188204.html b/docs/ims/api-ref/en-us_topic_0133188204.html index fcdf74b4b..9159d6d2d 100644 --- a/docs/ims/api-ref/en-us_topic_0133188204.html +++ b/docs/ims/api-ref/en-us_topic_0133188204.html @@ -12,7 +12,7 @@

              URI

              POST /v2/cloudimages/quickimport/action

              -

              Request

              • Parameters in the request body when an image file is used to create a system disk image +

                Request

                • Parameters in the request body when an image file in an OBS bucket is used to create a system disk image
              1
               2
               3
               4
              diff --git a/docs/ims/api-ref/en-us_topic_0093967372.html b/docs/ims/api-ref/en-us_topic_0093967372.html
              index e6bd75d42..b9a94bd33 100644
              --- a/docs/ims/api-ref/en-us_topic_0093967372.html
              +++ b/docs/ims/api-ref/en-us_topic_0093967372.html
              @@ -64,7 +64,9 @@
               

              String

              Specifies the type of the resource to be queried.

              +

              Specifies the type of the resource to be queried.

              +

              The value can be:

              +
              • image: private image
              • image_shared: shared image
              • image_member: image member

              used

              diff --git a/docs/ims/api-ref/en-us_topic_0102682861.html b/docs/ims/api-ref/en-us_topic_0102682861.html index a81f8657d..70e817405 100644 --- a/docs/ims/api-ref/en-us_topic_0102682861.html +++ b/docs/ims/api-ref/en-us_topic_0102682861.html @@ -277,8 +277,12 @@

              String

              Specifies the tag key, that is to say, the field name for the query operation. Valid values include resource_name and resource_id.

              -

              If the field name is resource_name and the value is an empty string, exact query is performed. Otherwise, fuzzy query is performed based on the image name. If the field name is resource_id, exact query is performed based on the image ID.

              +

              Specifies the tag key, that is, the field based on which images will be queried.

              +

              Constraints:

              +

              For the tag key resource_name, if the tag value is empty, exact query will be performed by image name. Otherwise, fuzzy query will be performed. If the tag key is resource_id, exact query will be performed by image ID.

              +

              The value can be:

              +

              resource_name: image name

              +

              resource_id: image ID

              value

              @@ -496,6 +500,8 @@

              Yes

              Specifies the image status.

              +

              The value can be:

              +
              • queued: The image metadata has already been created, and it is ready to upload the image file.
              • saving: The image file is being uploaded to the backend storage.
              • deleted: The image has been deleted.
              • killed: An error occurs on the image uploading.
              • active: The image is available for use.
              - - @@ -145,7 +150,7 @@

              Parameter

              Mandatory

              @@ -103,7 +103,12 @@

              String

              Specifies the image type. The parameter value is ECS/BMS for system disk images. The default value is ECS.

              +

              Specifies the image type.

              +

              The value can be:

              +

              ECS: ECS system disk image

              +

              BMS: BMS system disk image

              +

              Default value:

              +

              ECS

              enterprise_project_id

              @@ -123,10 +128,10 @@

              String

              Specifies the image architecture type. Available values include:

              +

              Specifies the image architecture type. The value can be:

              • x86
              • arm

              The default value is x86.

              -
              NOTE:

              If the image architecture is ARM, the boot mode is automatically changed to UEFI.

              +
              NOTE:

              If the image architecture is Arm, the boot mode is automatically changed to UEFI.

              -
            • Parameters description when an image file uploaded to the OBS bucket is used to create an image +
            • Parameters in the request body when an image file in an OBS bucket is used to create a data disk image
              @@ -233,8 +238,9 @@ - @@ -252,33 +258,34 @@

              Parameter

              Mandatory

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

              String

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

              -

              +

              Specifies the image type.

              +

              The value can be:

              +

              DataImage: data disk image

              enterprise_project_id

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

            • +

              -
              Table 1 Data structure of the image_tags field

              Parameter

              +
              - - - - - - - - - - - diff --git a/docs/ims/api-ref/en-us_topic_0170918588.html b/docs/ims/api-ref/en-us_topic_0170918588.html index 8d5fb49ae..207f3e5d8 100644 --- a/docs/ims/api-ref/en-us_topic_0170918588.html +++ b/docs/ims/api-ref/en-us_topic_0170918588.html @@ -3,7 +3,7 @@

              Querying an API Version (Native OpenStack API)

              Function

              This API is used to query a specified API version, such as version compatibility and domain name information of an API.

              -

              URI

              GET /{api_version}

              +

              URI

              GET /{version}

              Table 1 lists the parameters in the URI.

              Table 1 Data structure of the image_tags field

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              key

              +

              key

              Yes

              +

              Yes

              String

              +

              String

              Specifies the tag key.

              +

              Specifies the tag key.

              value

              +

              value

              Yes

              +

              Yes

              String

              +

              String

              Specifies the tag value.

              +

              Specifies the tag value.

              - @@ -69,6 +69,8 @@
              Table 1 Parameter description

              Parameter

              @@ -16,7 +16,7 @@

              api_version

              +

              version

              Yes

              String

              Specifies the API status.

              +

              The value can be:

              +
              • CURRENT: This is the preferred API version.
              • SUPPORTED: This is an old but still available API version.
              • DEPRECATED: This is a deprecated API version that will be removed.

              id