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 Asynchronous Job Query.
-You cannot export public images (such as Windows, SUSE Linux, Red Hat Linux, Oracle Linux, and Ubuntu) or private images created using these public images.
+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
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
@@ -279,7 +279,7 @@Array of objects
Specifies tags of the image. This parameter is left blank by default. Use either tags or image_tags.
+Specifies tags of the image. This parameter is left blank by default. Use either tags or image_tags.
type
@@ -300,7 +300,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.
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 +428,7 @@Specifies tags of the image. The value 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 +536,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 +546,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 +556,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.
2022-12-22
+2023-02-01
+Modified the following content:
+- Changed Redhat to Red Hat in Querying Images, Updating Image Information, Creating an Image, Querying Images (Native OpenStack API), Querying Image Details (Native OpenStack API), and Updating Image Information (Native OpenStack API).
- Added the restriction on the message body size for AK/SK authentication in section Uploading an Image (Native OpenStack API).
2022-12-22
Modified the following content:
- Deleted is_config_init from the example request in Creating an Image.
- Added the sub_jobs_result and sub_jobs_list response parameters in Asynchronous Job Query.
- Modified disk_format description in Querying Images, Querying Images (Native OpenStack API), Querying Image Details (Native OpenStack API), and Image Attributes.
- Added error codes IMG.0161, IMG.0162, IMG.0163, IMG.0164, IMG.0212, IMG.0238, IMG.0239, IMG.0241, IMG.0242, and IMG.1075 in Error Codes.
2020-08-12
Modified the following content:
-- Added the vault_id and whole_image_type fields and updated the example request in Creating a Full-ECS Image.
- Added the vault_id field and updated the example request in Updating the Status of Image Members in Batches.
- Added the vault_id field and updated the example request in Updating the Image Sharing Status in Batches (Native OpenStack API).
- Added the vault_id and whole_image_type fields and updated the example request in Creating a Full-ECS Image.
- Added the vault_id field and updated the example request in Updating the Status of Image Members in Batches.
- Added the vault_id field and updated the example request in Updating the Image Sharing Status in Batches (Native OpenStack API).
2019-01-30
Modified the following content:
-- Added parameter _support_fc_inject in Querying Images, Updating Image Information, Querying Images (Native OpenStack API), Querying Image Details (Native OpenStack API), and Updating Image Information (Native OpenStack API).
- Modified Creating an Image to allow users to create system disk images using data disks.
- Added "Common Query Methods" in Querying Images (Native OpenStack API).
- Added a note for parameter visibility in Querying Images (Native OpenStack API).
- Added parameter _support_fc_inject in Querying Images, Updating Image Information, Querying Images (Native OpenStack API), Querying Image Details (Native OpenStack API), and Updating Image Information (Native OpenStack API).
- Modified Creating an Image to allow users to create system disk images using data disks.
- Added "Common Query Methods" in Querying Images (Native OpenStack API).
- Added a note for parameter visibility in Querying Images (Native OpenStack API).
2018-09-30
@@ -185,7 +191,7 @@2017-02-08
- Updated the values of __os_version.
- Updated the values of __os_version.
2016-10-29
- Added the __is_config_init response parameter in Querying Images (Native OpenStack API).
- Added the __is_config_init response parameter in Querying Image Details (Native OpenStack API).
- Added the __is_config_init response parameter in Updating Image Information (Native OpenStack API).
- Added parameter is_config_init to the request body in Creating an Image. This parameter is mandatory when an image file uploaded to the OBS bucket is used to create an image.
- Added the __is_config_init response parameter in Querying Images (Native OpenStack API).
- Added the __is_config_init response parameter in Querying Image Details (Native OpenStack API).
- Added the __is_config_init response parameter in Updating Image Information (Native OpenStack API).
- Added parameter is_config_init to the request body in Creating an Image. This parameter is mandatory when an image file uploaded to the OBS bucket is used to create an image.
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.
+Request
- Request parameters
Parameter
diff --git a/docs/ims/api-ref/en-us_topic_0031617666.html b/docs/ims/api-ref/en-us_topic_0031617666.html index bae2a5d3..f7b53f2a 100644 --- a/docs/ims/api-ref/en-us_topic_0031617666.html +++ b/docs/ims/api-ref/en-us_topic_0031617666.html @@ -61,23 +61,23 @@Red Hat
Redhat Linux Enterprise 8.0 64bit
-Redhat Linux Enterprise 7.6 64bit
-Redhat Linux Enterprise 7.5 64bit
-Redhat Linux Enterprise 7.4 64bit
-Redhat Linux Enterprise 7.3 64bit
-Redhat Linux Enterprise 7.2 64bit
-Redhat Linux Enterprise 7.1 64bit
-Redhat Linux Enterprise 7.0 64bit
-Redhat Linux Enterprise 6.10 64bit
-Redhat Linux Enterprise 6.9 64bit
-Redhat Linux Enterprise 6.8 64bit
-Redhat Linux Enterprise 6.7 64bit
-Redhat Linux Enterprise 6.6 64bit
-Redhat Linux Enterprise 6.6 32bit
-Redhat Linux Enterprise 6.5 64bit
-Redhat Linux Enterprise 6.4 64bit
-Redhat Linux Enterprise 6.4 32bit
+Red Hat Linux Enterprise 8.0 64bit
+Red Hat 7.6 64bit
+Red Hat Linux Enterprise 7.5 64bit
+Red Hat Linux Enterprise 7.4 64bit
+Red Hat Linux Enterprise 7.3 64bit
+Red Hat Linux Enterprise 7.2 64bit
+Red Hat Linux Enterprise 7.1 64bit
+Red Hat Linux Enterprise 7.0 64bit
+Red Hat Linux Enterprise 6.10 64bit
+Red Hat Linux Enterprise 6.9 64bit
+Red Hat Linux Enterprise 6.8 64bit
+Red Hat Linux Enterprise 6.7 64bit
+Red Hat Linux Enterprise 6.6 64bit
+Red Hat Linux Enterprise 6.6 32bit
+Red Hat Linux Enterprise 6.5 64bit
+Red Hat Linux Enterprise 6.4 64bit
+Red Hat Linux Enterprise 6.4 32bit
Ubuntu
@@ -257,7 +257,7 @@CentOS 7.2 64bit
CentOS 6.5 64bit
SUSE SLES 11 SP4 64bit
-Redhat 7.2 64bit
+Red Hat 7.2 64bit
Windows 2012DC edition
SUSE Enterprise Linux Server 11 SP4 64bit
SUSE Enterprise Linux Server 12 SP1 64bit
SUSE Enterprise Linux Server 12 SP2 64bit
-Redhat Linux Enterprise 6.8 64bit
-Redhat Linux Enterprise 7.3 64bit
+Red Hat Linux Enterprise 6.8 64bit
+Red Hat Linux Enterprise 7.3 64bit
GPU-accelerated (G1)
@@ -299,8 +299,8 @@SUSE Enterprise Linux Server 11 SP4 64bit
SUSE Enterprise Linux Server 12 SP1 64bit
SUSE Enterprise Linux Server 12 SP2 64bit
-Redhat Linux Enterprise 6.8 64bit
-Redhat Linux Enterprise 7.3 64bit
+Red Hat Linux Enterprise 6.8 64bit
+Red Hat Linux Enterprise 7.3 64bit
High-performance generation I (H1)
@@ -315,8 +315,8 @@SUSE Enterprise Linux Server 11 SP4 64bit
SUSE Enterprise Linux Server 12 SP1 64bit
SUSE Enterprise Linux Server 12 SP2 64bit
-Redhat Linux Enterprise 6.8 64bit
-Redhat Linux Enterprise 7.3 64bit
+Red Hat Linux Enterprise 6.8 64bit
+Red Hat Linux Enterprise 7.3 64bit
High-performance generation II (H2)
@@ -324,7 +324,7 @@CentOS 6.5 64bit
CentOS 7.2 64bit
SUSE SLES 11 SP4 64bit
-Redhat 7.2 64bit
+Red Hat 7.2 64bit
Memory-optimized generation II (m2)
@@ -332,7 +332,7 @@CentOS 7.2 64bit
CentOS 6.5 64bit
SUSE SLES 11 SP4 64bit
-Redhat 7.2 64bit
+Red Hat 7.2 64bit
Windows 2012DC edition
String
Specifies the image platform type. The value can be Windows, Ubuntu, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
+Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
marker
@@ -241,7 +241,7 @@String
Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by large-memory ECSs, see Table 4.
+Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by large-memory ECSs, see Table 4.
__support_diskintensive
@@ -250,7 +250,7 @@String
Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by disk-intensive ECSs, see Table 4.
+Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by disk-intensive ECSs, see Table 4.
__support_highperformance
@@ -259,7 +259,7 @@String
Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by high-performance computing ECSs, see Table 4.
+Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required. For details about the image OSs supported by high-performance computing ECSs, see Table 4.
__support_xen_gpu_type
@@ -277,7 +277,7 @@String
Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
__support_xen_hana
@@ -287,7 +287,7 @@String
Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen and __support_kvm.
+This attribute cannot co-exist with __support_xen and __support_kvm.
__support_kvm_infiniband
@@ -297,7 +297,7 @@String
Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+This attribute cannot co-exist with __support_xen.
created_at
@@ -319,10 +319,10 @@String
Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.
+Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.
The following operators are supported:
- gt: greater than
- gte: greater than or equal to
- lt: less than
- lte: less than or equal to
- eq: equal to
- neq: not equal to
The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.
+The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.
For example, to query images updated before Oct 28, 2018 10:00:00, set the value of updated_at to lt:2018-10-28T10:00:00Z.
Response
- Response parameters
-
Parameter
+-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
@@ -384,7 +384,7 @@Table 2 Data structure description of the images field Parameter
+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
@@ -467,14 +467,14 @@String
Specifies the image type. The following types are supported:
-- Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
- Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
protected
Boolean
Specifies whether the image is protected. Set it to true when you query public images. This parameter is optional when you query private images.
+Specifies whether the image is protected. Set it to true when you query public images. This parameter is optional when you query private images.
virtual_env_type
@@ -519,7 +519,7 @@String
Specifies the image status. The value can be one of the following:
-- queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
- saving: indicates that the image file is being uploaded to the backend storage.
- deleted: indicates that the image has been deleted.
- killed: indicates that an error occurs on the image uploading.
- active: indicates that the image is available for use.
- queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
- saving: indicates that the image file is being uploaded to the backend storage.
- deleted: indicates that the image has been deleted.
- killed: indicates that an error occurs on the image uploading.
- active: indicates that the image is available for use.
name
@@ -547,7 +547,7 @@Integer
Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.
+Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications. Generally, the value is 0.
max_ram
@@ -582,7 +582,7 @@String
Specifies the image platform type. The value can be Windows, Ubuntu, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
+Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
schema
@@ -631,14 +631,14 @@String
Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports KVM. If yes, the value is true. Otherwise, this parameter is not required.
__support_xen
String
Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this parameter is not required.
__support_largememory
@@ -666,30 +666,30 @@String
Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. For details about the image OSs supported by GPU-accelerated ECSs, see Table 2. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the Xen platform. For details about the image OSs supported by GPU-accelerated ECSs, see Table 2. If the image does not support GPU-accelerated ECSs on the Xen platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
__support_kvm_gpu_type
String
Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
__support_xen_hana
String
Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen and __support_kvm.
__support_kvm_infiniband
String
Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
+This attribute cannot co-exist with __support_xen.
__root_origin
@@ -704,7 +704,7 @@String
Specifies the ECS system disk slot number corresponding to the image.
-Example value: 0
+Example value: 0
__support_fc_inject
diff --git a/docs/ims/api-ref/en-us_topic_0060804960.html b/docs/ims/api-ref/en-us_topic_0060804960.html index 12eeebe3..31862a2e 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
+-Table 2 v2.1 request message body Parameter
Mandatory
+Mandatory
Type
Type
Mandatory
+Mandatory
Description
Table 4 v2.0 request message body Parameter
+Table 4 v2.0 request message body Parameter
Mandatory
+Mandatory
Type
Type
Mandatory
+Mandatory
Description
String
Mandatory for replace and add, and not for remove
+Mandatory for replace and add, and not for remove
Indicates the value of the attribute to be updated or added. For detailed description, see Image Attributes.
Response
- Response parameters
-
Parameter
+Parameter
Type
String
Specifies the image platform type. The value can be Windows, Ubuntu, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
+Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
__os_type
diff --git a/docs/ims/api-ref/en-us_topic_0067360382.html b/docs/ims/api-ref/en-us_topic_0067360382.html index fd616ee6..9c14ee4d 100644 --- a/docs/ims/api-ref/en-us_topic_0067360382.html +++ b/docs/ims/api-ref/en-us_topic_0067360382.html @@ -163,7 +163,7 @@String
Specifies the image platform type. The value can be Windows, Ubuntu, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
+Specifies the image platform type. The value can be Windows, Ubuntu, Red Hat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
marker
@@ -256,7 +256,7 @@String
Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this parameter is not required.
For the supported OSs, see Table 4.
String
Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this parameter is not required.
__support_highperformance
@@ -276,7 +276,7 @@String
Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
+Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this parameter is not required.
__support_xen_gpu_type
@@ -294,7 +294,7 @@String
Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
+Specifies whether the image supports GPU-accelerated ECSs on the KVM platform. See Table 3 for its value. If the image does not support GPU-accelerated ECSs on the KVM platform, this parameter is not required. This attribute cannot co-exist with __support_xen and __support_kvm.
__support_xen_hana
@@ -304,7 +304,7 @@String
Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen and __support_kvm.
+This attribute cannot co-exist with __support_xen and __support_kvm.
__support_kvm_infiniband
@@ -314,7 +314,7 @@String
Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this parameter is not required.
-This attribute cannot co-exist with __support_xen.
+This attribute cannot co-exist with __support_xen.
virtual_env_type
@@ -358,7 +358,7 @@String
Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.
+Specifies the time when the image was modified. Images can be queried by time. The value is in the format of Operator:UTC time.
The following operators are supported:
- gt: greater than
- gte: greater than or equal to
- lt: less than
- lte: less than or equal to
- eq: equal to
- neq: not equal to
The time format is yyyy-MM-ddThh:mm:ssZ or yyyy-MM-dd hh:mm:ss.
diff --git a/docs/ims/api-ref/en-us_topic_0121671868.html b/docs/ims/api-ref/en-us_topic_0121671868.html new file mode 100644 index 00000000..574ed0b7 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0121671868.html @@ -0,0 +1,15 @@ + + +Calling APIs
+ +++ diff --git a/docs/ims/api-ref/en-us_topic_0121671869.html b/docs/ims/api-ref/en-us_topic_0121671869.html new file mode 100644 index 00000000..b8b7a52e --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0121671869.html @@ -0,0 +1,59 @@ + + +-
+
- Making an API Request
+
+ - Authentication
+
+ - Response
+
+
Authentication
++Requests for calling an API can be authenticated using either of the following methods:+- Token authentication: Requests are authenticated using tokens.
- AK/SK authentication: Requests are encrypted using AK/SK pairs. AK/SK authentication is recommended because it is more secure than token authentication.
+Token Authentication
+ The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
+A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. You can obtain a token by calling the Obtaining User Token API.
+A cloud service can be deployed as either a project-level service or global service.+- For a project-level service, you need to obtain a project-level token. When you call the API, set auth.scope in the request body to project.
- For a global service, you need to obtain a global token. When you call the API, set auth.scope in the request body to domain.
IMS is a project-level service. When you call the API, set auth.scope in the request body to project.
+{ + "auth": { + "identity": { + "methods": [ + "password" + ], + "password": { + "user": { + "name": "username", + "password": "********", + "domain": { + "name": "domainname" + } + } + } + }, + "scope": { + "project": { + "name": "xxxxxxxx" + } + } + } +}+After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
+++ +1 +2 +3
POST https://{{endpoint}}/v3/auth/projects +Content-Type: application/json +X-Auth-Token: ABCDEFJ.... +
+AK/SK Authentication
+ AK/SK authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token authentication is recommended.
+In AK/SK authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.
+- AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
- SK: secret access key, which is used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.
In AK/SK authentication, you can use an AK/SK to sign requests based on the signature algorithm or using the signing SDK.
++ The signing SDK is only used for signing requests and is different from the SDKs provided by services.
+++ diff --git a/docs/ims/api-ref/en-us_topic_0121673684.html b/docs/ims/api-ref/en-us_topic_0121673684.html new file mode 100644 index 00000000..3c587140 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0121673684.html @@ -0,0 +1,53 @@ + + +++Parent topic: Calling APIs+Obtaining a Project ID
+++Scenarios
A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:
+ ++Obtain the Project ID by Calling an API
You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.
+The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from . For details about API authentication, see Authentication.
+The following is an example response. The value of id is the project ID.
+{ + "projects": [ + { + "domain_id": "65382450e8f64ac0870cd180d14e684b", + "is_domain": false, + "parent_id": "65382450e8f64ac0870cd180d14e684b", + "name": "project_name", + "description": "", + "links": { + "next": null, + "previous": null, + "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" + }, + "id": "a4a5d4098fb4474fa22cd05f897d6b99", + "enabled": true + } + ], + "links": { + "next": null, + "previous": null, + "self": "https://www.example.com/v3/projects" + } +}++Obtain a Project ID from the Console
A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID:+- Log in to the management console.
- Click the username and select My Credentials from the drop-down list.
On the My Credentials page, view project IDs in the project list.
+Figure 1 Viewing project IDs+
In multi-project scenarios, expand the region, and obtain your sub-project ID from the Project ID column.
+
++ + + \ No newline at end of file diff --git a/docs/ims/api-ref/en-us_topic_0121682347.html b/docs/ims/api-ref/en-us_topic_0121682347.html new file mode 100644 index 00000000..9283c0eb --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0121682347.html @@ -0,0 +1,235 @@ + + +++Parent topic: Common Parameters+Making an API Request
++This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.
++Request URI
A request URI is in the following format:
+{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
+Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
+ ++
+Table 1 URI parameter description Parameter
+Description
+URI-scheme
+Protocol used to transmit requests. All APIs use HTTPS.
+Endpoint
+Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints.
+resource-path
+Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.
+query-string
+Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of Parameter name=Parameter value. For example, ? limit=10 indicates that a maximum of 10 data records will be displayed.
++ To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
++Request Methods
The HTTP protocol defines the following request methods that can be used to send a request to the server. +++
+Table 2 HTTP methods Method
+Description
+GET
+Requests the server to return specified resources.
+PUT
+Requests the server to update specified resources.
+POST
+Requests the server to add resources or perform special operations.
+DELETE
+Requests the server to delete specified resources, for example, an object.
+HEAD
+Same as GET except that the server must return only the response header.
+PATCH
+Requests the server to update partial content of a specified resource.
+If the resource does not exist, a new resource will be created.
+For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
+++ +1POST https://{{endpoint}}/v3/auth/tokens +
+Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.
+Common request header fields are as follows. +++
+Table 3 Common request header fields Parameter
+Description
+Mandatory
+Example Value
+Host
+Specifies the server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is in the format of Hostname:Port number. If the port number is not specified, the default port is used. The default port number for https is 443.
+No
+This field is mandatory for AK/SK authentication.
+code.test.com
+or
+code.test.com:443
+Content-Type
+Specifies the type (or format) of the message body. The default value application/json is recommended. Other values of this field will be provided for specific APIs if any.
+Yes
+application/json
+Content-Length
+Specifies the length of the request body. The unit is byte.
+No
+3495
+X-Project-Id
+Specifies the project ID. Obtain the project ID by following the instructions in Obtaining a Project ID.
+No
+e9993fc787d94b6c886cbaa340f9c0f4
+X-Auth-Token
+Specifies the user token.
+It is a response to the API for obtaining a user token (This is the only API that does not require authentication).
+After the request is processed, the value of X-Subject-Token in the response header is the token value.
+No
+This field is mandatory for token authentication.
+The following is part of an example token:
+MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
++ In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDKs to sign a request. During the signature, the Authorization (signature authentication) and X-Sdk-Date (time when a request is sent) headers are automatically added in the request.
+For more details, see "Authentication Using AK/SK" in Authentication.
+The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:
+++ +1 +2
POST https://{{endpoint}}/v3/auth/tokens +Content-Type: application/json +
+(Optional) Request Body
This part is optional. The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers content except the request header.
+The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
+In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with the actual values. Obtain a project name from Regions and Endpoints.
++ The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.
+++ +1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26
POST https://{{endpoint}}/v3/auth/tokens +Content-Type: application/json + +{ + "auth": { + "identity": { + "methods": [ + "password" + ], + "password": { + "user": { + "name": "username", + "password": "********", + "domain": { + "name": "domainname" + } + } + } + }, + "scope": { + "project": { + "name": "xxxxxxxxxxxxxxxxxx" + } + } + } +} +
If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.
+++ diff --git a/docs/ims/api-ref/en-us_topic_0170155703.html b/docs/ims/api-ref/en-us_topic_0170155703.html new file mode 100644 index 00000000..629b29d1 --- /dev/null +++ b/docs/ims/api-ref/en-us_topic_0170155703.html @@ -0,0 +1,66 @@ + + +++Parent topic: Calling APIs+Response
+++Status Code
After sending a request, you will receive a response, including a status code, response header, and response body.
+A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Codes.
+For example, if status code 201 is returned for calling the API used to , the request is successful.
++Response Header
Similar to a request, a response also has a header, for example, Content-Type.
+Figure 1 shows the response header fields for the API used to . The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
+ ++(Optional) Response Body
The body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.
+The following is part of the response body for the API used to .
+++ +1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12
{ + "token": { + "expires_at": "2019-02-13T06:52:13.855000Z", + "methods": [ + "password" + ], + "catalog": [ + { + "endpoints": [ + { + "region_id": "az-01", +...... +
If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
+++ +1 +2 +3 +4
{ + "error_msg": "The format of message is error", + "error_code": "AS.0001" +} +
In the response body, error_code is an error code, and error_msg provides information about the error.
+++ + + \ No newline at end of file diff --git a/docs/ims/api-ref/public_sys-resources/imageclose.gif b/docs/ims/api-ref/public_sys-resources/imageclose.gif new file mode 100644 index 00000000..3a3344af Binary files /dev/null and b/docs/ims/api-ref/public_sys-resources/imageclose.gif differ diff --git a/docs/ims/api-ref/public_sys-resources/imageclosehover.gif b/docs/ims/api-ref/public_sys-resources/imageclosehover.gif new file mode 100644 index 00000000..8699d5e3 Binary files /dev/null and b/docs/ims/api-ref/public_sys-resources/imageclosehover.gif differ diff --git a/docs/ims/api-ref/public_sys-resources/imagemax.gif b/docs/ims/api-ref/public_sys-resources/imagemax.gif new file mode 100644 index 00000000..99c07dc2 Binary files /dev/null and b/docs/ims/api-ref/public_sys-resources/imagemax.gif differ diff --git a/docs/ims/api-ref/public_sys-resources/imagemaxhover.gif b/docs/ims/api-ref/public_sys-resources/imagemaxhover.gif new file mode 100644 index 00000000..d01d77d6 Binary files /dev/null and b/docs/ims/api-ref/public_sys-resources/imagemaxhover.gif differ diff --git a/docs/ims/api-ref/public_sys-resources/macFFBgHack.png b/docs/ims/api-ref/public_sys-resources/macFFBgHack.png new file mode 100644 index 00000000..ec811470 Binary files /dev/null and b/docs/ims/api-ref/public_sys-resources/macFFBgHack.png differ++Parent topic: Calling APIs+
- Response parameters
-
