From 4b82dd4dc7a1aae5fc3016963121f6fd87ebd9ee Mon Sep 17 00:00:00 2001 From: "Zaoxu, Li" Date: Tue, 16 Jan 2024 15:27:30 +0000 Subject: [PATCH] ims_api0115 Reviewed-by: Pristromskaia, Margarita Co-authored-by: Zaoxu, Li Co-committed-by: Zaoxu, Li --- docs/ims/api-ref/en-us_topic_0020092109.html | 25 ++++++++++---------- docs/ims/api-ref/en-us_topic_0022473689.html | 10 ++++---- docs/ims/api-ref/en-us_topic_0024735403.html | 16 +++++++++---- docs/ims/api-ref/en-us_topic_0036994315.html | 2 +- docs/ims/api-ref/en-us_topic_0049147856.html | 2 +- 5 files changed, 31 insertions(+), 24 deletions(-) diff --git a/docs/ims/api-ref/en-us_topic_0020092109.html b/docs/ims/api-ref/en-us_topic_0020092109.html index daf528fc2..c4d1e481d 100644 --- a/docs/ims/api-ref/en-us_topic_0020092109.html +++ b/docs/ims/api-ref/en-us_topic_0020092109.html @@ -6,7 +6,7 @@

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

You cannot export public images (such as Windows, SUSE, Red Hat, Oracle Linux, and Ubuntu) or private images created using these public images.

-

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

  • Before using a data disk to create a system disk image, ensure that an OS has been installed on the data disk and has been optimized. For details about the optimization, see "Optimizing a Windows Private Image" and "Optimizing a Linux Private Image" in the Image Management Service User Guide.
  • The system cannot verify that an OS has been installed on the data disk. Therefore, ensure that the value of os_version is valid when creating a system disk image from the data disk. For details, see Values of Related Parameters.
+

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

  • Before using a data disk to create a system disk image, ensure that an OS has been installed on the data disk and has been optimized. For details about the optimization, see "Optimizing a Windows Private Image" and "Optimizing a Linux Private Image" in the Image Management Service User Guide.
  • The system cannot verify that an OS has been installed on the data disk. Therefore, ensure that the value of os_version is valid when creating a system disk image from the data disk. For details, see Values of Related Parameters.

URI

POST /v2/cloudimages/action

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

Array of objects

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

-

Use either tags or image_tags.

+

Use either tags or image_tags.

enterprise_project_id

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

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

Array of objects

-

Lists the image tags. This parameter is left blank by default. Use either tags or image_tags.

+

Lists the image tags. This parameter is left blank by default. Use either tags or image_tags.

type

@@ -289,8 +290,8 @@

String

Specifies the image type.

-

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

-
  • ECS and FusionCompute: indicate an ECS image.
  • BMS and Ironic: indicate a BMS image.
+

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

+
  • ECS and FusionCompute: indicate an ECS image.
  • BMS and Ironic: indicate a BMS image.
  • IsoImage: indicates an image created using an ISO file.

enterprise_project_id

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

String

Specifies the enterprise project that the image belongs to.

-
  • If the value is 0 or left blank, the image belongs to the default enterprise project.
  • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

    For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

    +
    • If the value is 0 or left blank, the image belongs to the default enterprise project.
    • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

      For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

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

    Integer

    -

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

    +

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

    data_images

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

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

    For detailed parameter descriptions, see Image Tag Data Formats.

    -

    Use either tags or image_tags.

    +

    Use either tags or image_tags.

    image_tags

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

    Array of strings

    Specifies tags of the image. This parameter is left blank by default.

    -

    Use either tags or image_tags.

    +

    Use either tags or image_tags.

    image_tags

    @@ -546,7 +547,7 @@

    Array of objects

    Specifies tags of the image. This parameter is left blank by default.

    -

    Use either tags or image_tags.

    +

    Use either tags or image_tags.

    enterprise_project_id

    @@ -556,7 +557,7 @@

    String

    Specifies the enterprise project that the image belongs to.

    -
    • If the value is 0 or left blank, the image belongs to the default enterprise project.
    • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

      For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

      +
      • If the value is 0 or left blank, the image belongs to the default enterprise project.
      • If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.

        For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

      diff --git a/docs/ims/api-ref/en-us_topic_0022473689.html b/docs/ims/api-ref/en-us_topic_0022473689.html index c27c13c62..076261d0d 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 @@

      forceCreate must be set to true.

      -

      forceCreate must be set to true.

      +

      forceCreate must be set to true.

      Set forceCreate to true.

      @@ -422,7 +422,7 @@

      An error occurred when the value of asumeToken was obtained.

      -

      An error occurred when the value of asumeToken was obtained.

      +

      An error occurred when the value of asumeToken was obtained.

      Contact technical support.

      @@ -1402,7 +1402,7 @@

      The value of hw_firmware_type is not uefi or bios.

      -

      The value of hw_firmware_type is not uefi or bios.

      +

      The value of hw_firmware_type is not uefi or bios.

      Set hw_firmware_type to uefi or bios.

      @@ -1919,9 +1919,9 @@

      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 933be6ae4..304be3712 100644 --- a/docs/ims/api-ref/en-us_topic_0024735403.html +++ b/docs/ims/api-ref/en-us_topic_0024735403.html @@ -8,7 +8,13 @@ -

      2023-12-22

      +

      2024-01-15

      + +

      Modified the following content:

      +

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

      + + +

      2023-12-22

      Modified the following content:

      @@ -61,7 +67,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:
      @@ -92,7 +98,7 @@

      2019-01-30

      Modified the following content:

      - +

      2018-09-30

      @@ -205,7 +211,7 @@

      2017-02-08

      -
      Modified the following content:
      • Updated the values of __os_version.
      +
      Modified the following content:
      • Updated the values of __os_version.
      @@ -227,7 +233,7 @@

      2016-10-29

      -
      Added the following content: +
      Added the following content:
      diff --git a/docs/ims/api-ref/en-us_topic_0036994315.html b/docs/ims/api-ref/en-us_topic_0036994315.html index b673ae8af..6fe0f0315 100644 --- a/docs/ims/api-ref/en-us_topic_0036994315.html +++ b/docs/ims/api-ref/en-us_topic_0036994315.html @@ -5,7 +5,7 @@

      Before exporting an image, ensure that you have the Tenant Administrator permission for OBS.

      -

      Constraints

      • An image can only be exported to a Standard bucket that is in the same region as the image.
      • The following private images cannot be exported:
        • Full-ECS images
        • Private images created from a Windows, SUSE, Red Hat, Ubuntu, or Oracle Linux public image
        +

        Constraints

        • An image can only be exported to a Standard bucket that is in the same region as the image.
        • The following private images cannot be exported:
          • Full-ECS images
          • ISO images
          • Private images created from a Windows, SUSE, Red Hat, Ubuntu, or Oracle Linux public image
        • The image size must be less than 1 TB. Images larger than 128 GB support only fast export.

        URI

        POST /v1/cloudimages/{image_id}/file

        diff --git a/docs/ims/api-ref/en-us_topic_0049147856.html b/docs/ims/api-ref/en-us_topic_0049147856.html index 54ae84d7b..8dc955d16 100644 --- a/docs/ims/api-ref/en-us_topic_0049147856.html +++ b/docs/ims/api-ref/en-us_topic_0049147856.html @@ -4,7 +4,7 @@

        Function

        This API is an extension one and is used to copy an existing image to another image. When replicating an image, you can change the image attributes to meet the requirements of different scenarios.

        This API is an asynchronous one. If job_id is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is success, the task is successfully executed. If the status is failed, the task fails. For details about how to query the status of an asynchronous task, see Querying the Status of an Asynchronous Job.

        -

        Constraints

        • Full-ECS images cannot be replicated.
        +

        Constraints

        • Full-ECS images cannot be replicated.
        • Private images created using ISO files do not support in-region replication.

        URI

        POST /v1/cloudimages/{image_id}/copy

        Table 1 lists the parameters in the URI.