- What's New
- Function Overview
- Service Overview
- Getting Started
-
User Guide
- Using IAM to Grant Access to IMS
-
Creating a Private Image
- Introduction
- Creating a System Disk Image from a Windows ECS
- Creating a System Disk Image from a Linux ECS
- Creating a Windows System Disk Image from an External Image File
- Creating a Linux System Disk Image from an External Image File
- Creating a BMS System Disk Image
- Creating a Data Disk Image from an ECS
- Creating a Data Disk Image from an External Image File
- Creating a Full-ECS Image from an ECS
- Creating a Full-ECS Image from a CSBS Backup
- Creating a Full-ECS Image from a CBR Backup
- Creating a Windows System Disk Image from an ISO File
- Creating a Linux System Disk Image from an ISO File
- Importing an Image
- Fast Import of an Image File
-
Managing Private Images
- Creating an ECS from an Image
- Modifying an Image
- Exporting an Image
- Exporting Image List
- Checking the Disk Capacity of an Image
- Deleting Images
-
Sharing Images
- Overview
- Obtaining the Project ID, Account ID, and Organization URN
- Sharing Specified Images
- Accepting or Rejecting Shared Images
- Rejecting Accepted Images
- Accepting Rejected Images
- Stopping Sharing Images
- Adding Tenants Who Can Use Shared Images
- Deleting Image Recipients Who Can Use Shared Images
- Replicating a Shared Image
- Replicating Images Within a Region
- Replicating Images Across Regions
- Optimizing a Windows Private Image
-
Optimizing a Linux Private Image
- Optimization Process
- Checking Whether a Private Image Needs to be Optimized
- Using a Script to Optimize a Xen Private Image
- Uninstalling PV Drivers from a Linux ECS
- Changing Disk Identifiers in the GRUB File to UUID
- Changing Disk Identifiers in the fstab File to UUID
- Installing Native Xen and KVM Drivers
- Installing Native KVM Drivers
- Clearing System Logs
- Encrypting Images
- Windows Operations
- Linux Operations
- Managing Public Images
- Managing Tags
- Managing Quotas
- Auditing Key Operations
-
Best Practices
- Overview
- Creating a Windows Image Using VirtualBox and an ISO File
- Creating a Linux Image Using VirtualBox and an ISO File
- Cleaning Up the Disk Space of a Windows ECS
- Converting the Image Format
- Creating a Private Image Using Packer
- Configuring an ISO File as a Local Image Source
- Migrating ECSs Across Accounts and Regions
- Migrating Service Data Across Accounts (Data Disks)
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- Getting Started
- IMS APIs
- Native OpenStack APIs
- Examples
- Permission Policies and Supported Actions
- Common Parameters
-
Historical APIs
-
Image (Native OpenStack APIs)
- Querying Images (Native OpenStack API V2, Discarded)
- Querying Image Details (Native OpenStack API V2, Discarded)
- Modifying an Image (Native OpenStack API V2, Discarded)
- Uploading an Image (Native OpenStack API V2, Discarded)
- Deleting an Image (Native OpenStack API V1.1, Discarded)
- Querying Image Metadata (Native OpenStack API V1, Discarded)
- Querying Image Details (Native OpenStack API V1.1, Discarded)
- Image Tagging (Native OpenStack APIs)
- Image Sharing (Native OpenStack APIs)
-
Image (Native OpenStack APIs)
- Status Codes
- Error Codes
- SDK Reference
-
FAQs
-
Image Consulting
- How Do I Select an Image?
- What Do I Do If I Cannot Find a Desired Image?
- Are There Any Public Images Already Containing Certain Applications, Such as OpenVPN or PyTorch?
- What Are the Differences Between Images and Backups?
- Can I Tailor an Image?
- How Do I Migrate an ECS to a Different Region of Another Account?
- How Can I Back Up the Current Status of an ECS for Restoration in the Case of a System Fault?
- How Can I Apply a Private Image to an Existing ECS?
- Can I Import Data from a Data Disk Image to a Data Disk?
- Can I Use Private Images of Other Accounts?
- End-of-Support for OSs
-
Image Creation
- General Creation FAQ
- Full-ECS Image FAQ
- How Can I Use a Backup to Create an EVS Disk or ECS?
- Is There Any Difference Between the Image Created from a CSBS/CBR Backup and That Created from an ECS?
- Why Can't I Find an ISO Image When I Want to Use It to Create an ECS or Change the OS of an ECS?
- How Do I Create a Full-ECS Image Using an ECS That Has a Spanned Volume?
- Why Is Sysprep Required for Creating a Private Image from a Windows ECS?
- How Do I Handle the Startup Failure of a Windows ECS Created from a Windows Image Generalized by Sysprep?
- What Do I Do If I Cannot Create an Image in ZVHD2 Format Using an API?
- Image Sharing
-
OS
- How Do I Select an OS?
- How Is BIOS Different from UEFI?
- What Do I Do If I Cannot Change the Resolution of a Windows OS Booted in UEFI Mode?
- How Do I Delete Redundant Network Connections from a Windows ECS?
- What Do I Do If an ECS Starts Slowly?
- What Do I Do If the One-Click Password Resetting Plug-In Failed to Start?
- Why Can't I Find My Private Image When I Want to Use It to Create an ECS or Change the OS of an ECS?
-
Image Import
- Can I Use Images in Formats not Described in This Document?
- What Are the Impacts If I Do Not Pre-configure an ECS Used to Create a Private Image?
- How Do I Import an OVF or OVA File to the Cloud Platform?
- What Do I Do If I Chose the Wrong OS or System Disk Capacity When Registering a Private Image?
- Why Did My VHD Upload Fail? Why Does the System Say the System Disk in the VHD Image File Is Larger Than What I Specified on the Management Console?
- How Do I Import Existing Huawei Cloud Private Images to a Specified Region?
-
Image Export
- Can I Download My Private Images to a Local PC?
- Can I Use the System Disk Image of an ECS on a BMS After I Export It from the Cloud Platform?
- Why Is the Image Size in an OBS Bucket Different from That Displayed in IMS?
- Can I Download a Public Image to My PC?
- What Are the Differences Between Import/Export and Fast Import/Export?
- Why the Export Option Is Unavailable for My Image?
-
Image Optimization
- Must I Install Guest OS Drivers on an ECS?
- Why Do I Need to Install and Update VirtIO Drivers for Windows?
- What Will the System Do to an Image File When I Use the File to Register a Private Image?
- How Do I Configure an ECS, a BMS, or an Image File Before I Use It to Create an Image?
- What Do I Do If a Windows Image File Is Not Pre-Configured When I Use It to Register a Private Image?
- What Do I Do If a Linux Image File Is Not Pre-Configured When I Use It to Register a Private Image?
- How Do I Optimize an Image?
- How Do I Use a Private Image Created from a First-Generation ECS to Create a Second-Generation ECS?
- How Do I Enable NIC Multi-Queue for an Image?
- How Do I Configure an ECS to Use DHCPv6?
- How Do I Make a System Disk Image Support Fast ECS Creation?
- Why Did I Fail to Install Guest OS Drivers on a Windows ECS?
- How Do I Install Native Xen and KVM Drivers?
- Image Replication
- Image Deletion
- Image Encryption
- KooGallery Images
- Accounts and Permissions
- Cloud-Init
-
ECS Creation
- Can I Change the Image of a Purchased ECS?
- Can I Change the Specifications Defined by a Private Image When I Use the Image to Create an ECS?
- Can I Specify the System Disk Capacity When I Create an ECS Using an Image?
- What Do I Do If a Partition Is Not Found During the Startup of an ECS Created from an Imported Private Image?
- What Do I Do If the Disks of a CentOS ECS Created from an Image Cannot Be Found?
- What Do I Do If I Enabled Automatic Configuration During Image Registration for an ECS Created from a Windows Image and Now It Won't Start?
- What Do I Do If an Exception Occurs When I Start an ECS Created from an Image Using UEFI Boot?
-
Driver Installation
- Must I Install Guest OS Drivers on an ECS?
- Why Do I Need to Install and Update VirtIO Drivers for Windows?
- Why Did I Fail to Install Guest OS Drivers on a Windows ECS?
- How Do I Install PV Drivers in Windows?
- How Do I Install VirtIO Drivers in Windows?
- How Do I Install Native KVM Drivers in Linux?
- How Do I Install Native Xen and KVM Drivers?
- Image Tags
- Billing
-
Image Consulting
- Videos
- Glossary
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Overview
- Using IAM to Grant Access to IMS
-
Creating a Private Image
- Introduction
- Creating a System Disk Image from a Windows ECS
- Creating a System Disk Image from a Linux ECS
- Creating a Windows System Disk Image from an External Image File
- Creating a Linux System Disk Image from an External Image File
- Creating a BMS System Disk Image
- Creating a Data Disk Image from an ECS
- Creating a Data Disk Image from an External Image File
- Creating a Full-ECS Image from an ECS
- Creating a Full-ECS Image from a CBR Backup
- Creating a Windows System Disk Image from an ISO File
- Creating a Linux System Disk Image from an ISO File
- Importing an Image
- Fast Import of an Image File
-
Managing Private Images
- Creating an ECS from an Image
- Modifying an Image
- Exporting an Image
- Exporting Image List
- Checking the Disk Capacity of an Image
- Deleting Images
-
Sharing Images
- Overview
- Obtaining the Account Name and Project Name
- Sharing Specified Images
- Accepting or Rejecting Shared Images
- Rejecting Accepted Images
- Accepting Rejected Images
- Stopping Sharing Images
- Adding Tenants Who Can Use Shared Images
- Deleting Image Recipients Who Can Use Shared Images
- Replicating a Shared Image
- Replicating Images
- Optimizing a Windows Private Image
-
Optimizing a Linux Private Image
- Optimization Process
- Checking Whether a Private Image Needs to be Optimized
- Uninstalling PV Drivers from a Linux ECS
- Changing Disk Identifiers in the GRUB File to UUID
- Changing Disk Identifiers in the fstab File to UUID
- Installing Native Xen and KVM Drivers
- Installing Native KVM Drivers
- Clearing System Logs
- Encrypting Images
- Converting the Image Format
- Windows Operations
- Linux Operations
- Managing Tags
- Managing Quotas
- Auditing Key Operations
-
FAQs
-
Image Consulting
- Basic Concepts
- How Do I Select an Image?
- What Do I Do If I Cannot Find a Desired Image?
- What Are the Differences Between Images and Backups?
- Can I Tailor an Image?
- How Can I Back Up the Current Status of an ECS for Restoration in the Case of a System Fault?
- How Can I Apply a Private Image to an Existing ECS?
- Can I Import Data from a Data Disk Image to a Data Disk?
- Can I Use Private Images of Other Accounts?
-
Image Creation
- General Creation FAQ
- Full-ECS Image FAQ
- Is There Any Difference Between the Image Created from a CSBS/CBR Backup and That Created from an ECS?
- Why Can't I Find an ISO Image When I Want to Use It to Create an ECS or Change the OS of an ECS?
- How Do I Create a Full-ECS Image Using an ECS That Has a Spanned Volume?
- Why Is Sysprep Required for Creating a Private Image from a Windows ECS?
- How Do I Handle the Startup Failure of a Windows ECS Created from a Windows Image Generalized by Sysprep?
- What Do I Do If I Cannot Create an Image in ZVHD2 Format Using an API?
- Image Sharing
- OS
-
Image Import
- Can I Use Images in Formats not Described in This Document?
- What Are the Impacts If I Do Not Pre-configure an ECS Used to Create a Private Image?
- How Do I Import an OVF or OVA File to the Cloud Platform?
- What Do I Do If I Chose the Wrong OS or System Disk Capacity When Registering a Private Image?
- Why Did My VHD Upload Fail? Why Does the System Say the System Disk in the VHD Image File Is Larger Than What I Specified on the Management Console?
-
Image Export
- Can I Download My Private Images to a Local PC?
- Can I Use the System Disk Image of an ECS on a BMS After I Export It from the Cloud Platform?
- Why Is the Image Size in an OBS Bucket Different from That Displayed in IMS?
- Can I Download a Public Image to My PC?
- What Are the Differences Between Import/Export and Fast Import/Export?
- Why the Export Option Is Unavailable for My Image?
-
Image Optimization
- Must I Install Guest OS Drivers on an ECS?
- Why Do I Need to Install and Update VirtIO Drivers for Windows?
- What Will the System Do to an Image File When I Use the File to Register a Private Image?
- How Do I Configure an ECS or an Image File Before I Use It to Create an Image?
- What Do I Do If a Windows Image File Is Not Pre-Configured When I Use It to Register a Private Image?
- What Do I Do If a Linux Image File Is Not Pre-Configured When I Use It to Register a Private Image?
- How Do I Enable NIC Multi-Queue for an Image?
- How Do I Configure an ECS to Use DHCPv6?
- How Do I Make a System Disk Image Support Fast ECS Creation?
- Why Did I Fail to Install Guest OS Drivers on a Windows ECS?
- How Do I Install Native Xen and KVM Drivers?
- Image Replication
- Image Deletion
- Image Encryption
- Accounts and Permissions
- Cloud-Init
-
ECS Creation
- Can I Change the Image of a Purchased ECS?
- Can I Change the Specifications Defined by a Private Image When I Use the Image to Create an ECS?
- Can I Specify the System Disk Capacity When I Create an ECS Using an Image?
- What Do I Do If a Partition Is Not Found During the Startup of an ECS Created from an Imported Private Image?
- What Do I Do If the Disks of a CentOS ECS Created from an Image Cannot Be Found?
- What Do I Do If I Enabled Automatic Configuration During Image Registration for an ECS Created from a Windows Image and Now It Won't Start?
- What Do I Do If an Exception Occurs When I Start an ECS Created from an Image Using UEFI Boot?
-
Driver Installation
- Must I Install Guest OS Drivers on an ECS?
- Why Do I Need to Install and Update VirtIO Drivers for Windows?
- Why Did I Fail to Install Guest OS Drivers on a Windows ECS?
- How Do I Install VirtIO Drivers in Windows?
- How Do I Install Native KVM Drivers in Linux?
- How Do I Install Native Xen and KVM Drivers?
- Image Tags
- Billing
-
Image Consulting
-
API Reference (ME-Abu Dhabi Region)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
- IMS APIs
-
Native OpenStack APIs
-
Image (Native OpenStack APIs)
- Querying Images (Native OpenStack API)
- Querying Image Details (Native OpenStack API)
- Updating Image Information (Native OpenStack API)
- Uploading an Image (Native OpenStack API)
- Deleting an Image (Native OpenStack API)
- Creating Image Metadata (Native OpenStack API)
- Deleting an Image (Native OpenStack API v1.1 - Abandoned and Not Recommended)
- Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended)
- Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)
- Image Schema (Native OpenStack APIs)
- Image Sharing (Native OpenStack APIs)
- API Version Query (Native OpenStack API)
-
Image (Native OpenStack APIs)
- Examples
- Permission Policies and Supported Actions
- Common Parameters
- Status Codes
- Error Codes
- Change History
-
User Guide (Paris Regions)
- Overview
- Using IAM to Grant Access to IMS
-
Creating a Private Image
- Introduction
- Creating a System Disk Image from a Windows ECS
- Creating a System Disk Image from a Linux ECS
- Creating a Windows System Disk Image from an External Image File
- Creating a Linux System Disk Image from an External Image File
- Creating a Data Disk Image from an External Image File
- Creating a Full-ECS Image from an ECS
- Creating a Full-ECS Image from a CSBS Backup
- Creating a Full-ECS Image from a CBR Backup
- Creating a Windows System Disk Image from an ISO File
- Creating a Linux System Disk Image from an ISO File
- Importing an Image
- Fast Import of an Image File
-
Managing Private Images
- Creating an ECS from an Image
- Modifying an Image
- Exporting an Image
- Exporting Image List
- Checking the Disk Capacity of an Image
- Deleting Images
- Sharing Images
- Replicating Images Within a Region
- Optimizing a Windows Private Image
-
Optimizing a Linux Private Image
- Optimization Process
- Checking Whether a Private Image Needs to be Optimized
- Uninstalling PV Drivers from a Linux ECS
- Changing Disk Identifiers in the GRUB File to UUID
- Changing Disk Identifiers in the fstab File to UUID
- Installing Native Xen and KVM Drivers
- Installing Native KVM Drivers
- Clearing System Logs
- Encrypting Images
- Converting the Image Format
- Windows Operations
- Linux Operations
- Managing Tags
- Managing Quotas
- Auditing Key Operations
-
FAQs
-
Image Consulting
- Basic Concepts
- How Do I Select an Image?
- What Do I Do If I Cannot Find a Desired Image?
- What Are the Differences Between Images and Backups?
- Can I Tailor an Image?
- How Can I Back Up the Current Status of an ECS for Restoration in the Case of a System Fault?
- How Can I Apply a Private Image to an Existing ECS?
- Can I Import Data from a Data Disk Image to a Data Disk?
- Can I Use Private Images of Other Accounts?
- End-of-Support for OSs
-
Image Creation
- General Creation FAQ
- Full-ECS Image FAQ
- How Can I Use a Backup to Create an EVS Disk or ECS?
- Is There Any Difference Between the Image Created from a CSBS/CBR Backup and That Created from an ECS?
- Why Can't I Find an ISO Image When I Want to Use It to Create an ECS or Change the OS of an ECS?
- How Do I Create a Full-ECS Image Using an ECS That Has a Spanned Volume?
- Why Is Sysprep Required for Creating a Private Image from a Windows ECS?
- How Do I Handle the Startup Failure of a Windows ECS Created from a Windows Image Generalized by Sysprep?
- What Do I Do If I Cannot Create an Image in ZVHD2 Format Using an API?
- Image Sharing
-
OS
- How Do I Select an OS?
- How Is BIOS Different from UEFI?
- How Do I Delete Redundant Network Connections from a Windows ECS?
- What Do I Do If an ECS Starts Slowly?
- What Do I Do If a Windows 7 ECS Equipped with an Intel 82599 NIC Reports an Error in SR-IOV Scenarios?
- Why Can't I Find My Private Image When I Want to Use It to Create an ECS or Change the OS of an ECS?
-
Image Import
- Can I Use Images in Formats not Described in This Document?
- What Are the Impacts If I Do Not Pre-configure an ECS Used to Create a Private Image?
- What Do I Do If I Chose the Wrong OS or System Disk Capacity When Registering a Private Image?
- Why Did My VHD Upload Fail? Why Does the System Say the System Disk in the VHD Image File Is Larger Than What I Specified on the Management Console?
-
Image Export
- Can I Download My Private Images to a Local PC?
- Can I Use the System Disk Image of an ECS on a BMS After I Export It from the Cloud Platform?
- Why Is the Image Size in an OBS Bucket Different from That Displayed in IMS?
- Can I Download a Public Image to My PC?
- What Are the Differences Between Import/Export and Fast Import/Export?
- Why the Export Option Is Unavailable for My Image?
-
Image Optimization
- Must I Install Guest OS Drivers on an ECS?
- Why Do I Need to Install and Update VirtIO Drivers for Windows?
- What Will the System Do to an Image File When I Use the File to Register a Private Image?
- How Do I Configure an ECS, a BMS, or an Image File Before I Use It to Create an Image?
- What Do I Do If a Windows Image File Is Not Pre-Configured When I Use It to Register a Private Image?
- What Do I Do If a Linux Image File Is Not Pre-Configured When I Use It to Register a Private Image?
- How Do I Enable NIC Multi-Queue for an Image?
- How Do I Make a System Disk Image Support Fast ECS Creation?
- Why Did I Fail to Install Guest OS Drivers on a Windows ECS?
- How Do I Install Native Xen and KVM Drivers?
- Image Replication
- Image Deletion
- Image Encryption
- Accounts and Permissions
- Cloud-Init
-
ECS Creation
- Can I Change the Image of a Purchased ECS?
- Can I Change the Specifications Defined by a Private Image When I Use the Image to Create an ECS?
- Can I Specify the System Disk Capacity When I Create an ECS Using an Image?
- What Do I Do If a Partition Is Not Found During the Startup of an ECS Created from an Imported Private Image?
- What Do I Do If the Disks of a CentOS ECS Created from an Image Cannot Be Found?
- What Do I Do If I Enabled Automatic Configuration During Image Registration for an ECS Created from a Windows Image and Now It Won't Start?
- What Do I Do If an Exception Occurs When I Start an ECS Created from an Image Using UEFI Boot?
-
Driver Installation
- Must I Install Guest OS Drivers on an ECS?
- Why Do I Need to Install and Update VirtIO Drivers for Windows?
- Why Did I Fail to Install Guest OS Drivers on a Windows ECS?
- How Do I Install VirtIO Drivers in Windows?
- How Do I Install Native KVM Drivers in Linux?
- How Do I Install Native Xen and KVM Drivers?
- Image Tags
-
Image Consulting
-
API Reference (Paris Regions)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
- IMS APIs
-
Native OpenStack APIs
-
Image (Native OpenStack APIs)
- Querying Images (Native OpenStack API)
- Querying Image Details (Native OpenStack API)
- Updating Image Information (Native OpenStack API)
- Uploading an Image (Native OpenStack API)
- Deleting an Image (Native OpenStack API)
- Creating Image Metadata (Native OpenStack API)
- Deleting an Image (Native OpenStack API v1.1 - Abandoned and Not Recommended)
- Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended)
- Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)
- Image Tagging (Native OpenStack APIs)
- Image Schema (Native OpenStack APIs)
- Image Sharing (Native OpenStack APIs)
- API Version Query (Native OpenStack API)
-
Image (Native OpenStack APIs)
- Examples
- API Actions
- Common Parameters
- Status Codes
- Error Codes
- Change History
-
User Guide (Kuala Lumpur Region)
- Overview
- Using IAM to Grant Access to IMS
-
Creating a Private Image
- Introduction
- Creating a System Disk Image from a Windows ECS
- Creating a System Disk Image from a Linux ECS
- Creating a Windows System Disk Image from an External Image File
- Creating a Linux System Disk Image from an External Image File
- Creating a BMS System Disk Image
- Creating a Data Disk Image from an ECS
- Creating a Data Disk Image from an External Image File
- Creating a Full-ECS Image from an ECS
- Creating a Full-ECS Image from a CBR Backup
- Creating a Windows System Disk Image from an ISO File
- Creating a Linux System Disk Image from an ISO File
- Importing an Image
- Fast Import of an Image File
-
Managing Private Images
- Creating an ECS from an Image
- Modifying an Image
- Exporting an Image
- Exporting Image List
- Checking the Disk Capacity of an Image
- Deleting Images
-
Sharing Images
- Overview
- Obtaining the Account Name and Project Name
- Sharing Specified Images
- Accepting or Rejecting Shared Images
- Rejecting Accepted Images
- Accepting Rejected Images
- Stopping Sharing Images
- Adding Tenants Who Can Use Shared Images
- Deleting Image Recipients Who Can Use Shared Images
- Replicating a Shared Image
- Replicating Images Within a Region
- Optimizing a Windows Private Image
-
Optimizing a Linux Private Image
- Optimization Process
- Checking Whether a Private Image Needs to be Optimized
- Uninstalling PV Drivers from a Linux ECS
- Changing Disk Identifiers in the GRUB File to UUID
- Changing Disk Identifiers in the fstab File to UUID
- Installing Native Xen and KVM Drivers
- Installing Native KVM Drivers
- Clearing System Logs
- Encrypting Images
- Converting the Image Format
- Windows Operations
- Linux Operations
- Managing Tags
- Managing Quotas
- Auditing Key Operations
-
FAQs
-
Image Consulting
- Basic Concepts
- How Do I Select an Image?
- What Do I Do If I Cannot Find a Desired Image?
- What Are the Differences Between Images and Backups?
- Can I Tailor an Image?
- How Can I Back Up the Current Status of an ECS for Restoration in the Case of a System Fault?
- How Can I Apply a Private Image to an Existing ECS?
- Can I Import Data from a Data Disk Image to a Data Disk?
- Can I Use Private Images of Other Accounts?
- End-of-Support for OSs
-
Image Creation
- General Creation FAQ
- Full-ECS Image FAQ
- Is There Any Difference Between the Image Created from a CSBS/CBR Backup and That Created from an ECS?
- Why Can't I Find an ISO Image When I Want to Use It to Create an ECS or Change the OS of an ECS?
- How Do I Create a Full-ECS Image Using an ECS That Has a Spanned Volume?
- Why Is Sysprep Required for Creating a Private Image from a Windows ECS?
- How Do I Handle the Startup Failure of a Windows ECS Created from a Windows Image Generalized by Sysprep?
- What Do I Do If I Cannot Create an Image in ZVHD2 Format Using an API?
- Image Sharing
- OS
-
Image Import
- Can I Use Images in Formats not Described in This Document?
- What Are the Impacts If I Do Not Pre-configure an ECS Used to Create a Private Image?
- How Do I Import an OVF or OVA File to the Cloud Platform?
- What Do I Do If I Chose the Wrong OS or System Disk Capacity When Registering a Private Image?
- Why Did My VHD Upload Fail? Why Does the System Say the System Disk in the VHD Image File Is Larger Than What I Specified on the Management Console?
-
Image Export
- Can I Download My Private Images to a Local PC?
- Can I Use the System Disk Image of an ECS on a BMS After I Export It from the Cloud Platform?
- Why Is the Image Size in an OBS Bucket Different from That Displayed in IMS?
- Can I Download a Public Image to My PC?
- What Are the Differences Between Import/Export and Fast Import/Export?
- Why the Export Option Is Unavailable for My Image?
-
Image Optimization
- Must I Install Guest OS Drivers on an ECS?
- Why Do I Need to Install and Update VirtIO Drivers for Windows?
- What Will the System Do to an Image File When I Use the File to Register a Private Image?
- How Do I Configure an ECS or an Image File Before I Use It to Create an Image?
- What Do I Do If a Windows Image File Is Not Pre-Configured When I Use It to Register a Private Image?
- What Do I Do If a Linux Image File Is Not Pre-Configured When I Use It to Register a Private Image?
- How Do I Enable NIC Multi-Queue for an Image?
- How Do I Configure an ECS to Use DHCPv6?
- How Do I Make a System Disk Image Support Fast ECS Creation?
- Why Did I Fail to Install Guest OS Drivers on a Windows ECS?
- How Do I Install Native Xen and KVM Drivers?
- Image Replication
- Image Deletion
- Image Encryption
- Accounts and Permissions
- Cloud-Init
-
ECS Creation
- Can I Change the Image of a Purchased ECS?
- Can I Change the Specifications Defined by a Private Image When I Use the Image to Create an ECS?
- Can I Specify the System Disk Capacity When I Create an ECS Using an Image?
- What Do I Do If a Partition Is Not Found During the Startup of an ECS Created from an Imported Private Image?
- What Do I Do If the Disks of a CentOS ECS Created from an Image Cannot Be Found?
- What Do I Do If I Enabled Automatic Configuration During Image Registration for an ECS Created from a Windows Image and Now It Won't Start?
- What Do I Do If an Exception Occurs When I Start an ECS Created from an Image Using UEFI Boot?
-
Driver Installation
- Must I Install Guest OS Drivers on an ECS?
- Why Do I Need to Install and Update VirtIO Drivers for Windows?
- Why Did I Fail to Install Guest OS Drivers on a Windows ECS?
- How Do I Install VirtIO Drivers in Windows?
- How Do I Install Native KVM Drivers in Linux?
- How Do I Install Native Xen and KVM Drivers?
- Image Tags
-
Image Consulting
-
API Reference (Kuala Lumpur Region)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
- IMS APIs
-
Native OpenStack APIs
-
Image (Native OpenStack APIs)
- Querying Images (Native OpenStack API)
- Querying Image Details (Native OpenStack API)
- Updating Image Information (Native OpenStack API)
- Uploading an Image (Native OpenStack API)
- Deleting an Image (Native OpenStack API)
- Creating Image Metadata (Native OpenStack API)
- Deleting an Image (Native OpenStack API v1.1 - Abandoned and Not Recommended)
- Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended)
- Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)
- Image Schema (Native OpenStack APIs)
- Image Sharing (Native OpenStack APIs)
- API Version Query (Native OpenStack API)
-
Image (Native OpenStack APIs)
- Examples
- Permission Policies and Supported Actions
- Common Parameters
- Status Codes
- Error Codes
- Change History
-
User Guide (Ankara Region)
- Overview
- Using IAM to Grant Access to IMS
-
Creating a Private Image
- Introduction
- Creating a System Disk Image from a Windows ECS
- Creating a System Disk Image from a Linux ECS
- Creating a Windows System Disk Image from an External Image File
- Creating a Linux System Disk Image from an External Image File
- Creating a Data Disk Image from an ECS
- Creating a Data Disk Image from an External Image File
- Creating a Full-ECS Image from an ECS
- Creating a Full-ECS Image from a CSBS Backup
- Creating a Full-ECS Image from a CBR Backup
- Creating a Windows System Disk Image from an ISO File
- Creating a Linux System Disk Image from an ISO File
- Fast Import of an Image File
-
Managing Private Images
- Creating an ECS from an Image
- Modifying an Image
- Exporting an Image
- Exporting Image List
- Checking the Disk Capacity of an Image
- Deleting Images
- Sharing Images
- Replicating Images
- Optimizing a Windows Private Image
-
Optimizing a Linux Private Image
- Optimization Process
- Checking Whether a Private Image Needs to be Optimized
- Uninstalling PV Drivers from a Linux ECS
- Changing Disk Identifiers in the GRUB File to UUID
- Changing Disk Identifiers in the fstab File to UUID
- Installing Native Xen and KVM Drivers
- Installing Native KVM Drivers
- Clearing System Logs
- Converting the Image Format
- Windows Operations
- Linux Operations
- Managing Tags
- Managing Quotas
- Auditing Key Operations
-
FAQs
-
Image Consulting
- How Do I Select an Image?
- What Are the Differences Between Images and Backups?
- Can I Tailor an Image?
- How Can I Back Up the Current Status of an ECS for Restoration in the Case of a System Fault?
- How Can I Apply a Private Image to an Existing ECS?
- Can I Import Data from a Data Disk Image to a Data Disk?
- Can I Use Private Images of Other Accounts?
-
Image Creation
- General Creation FAQ
- Full-ECS Image FAQ
- Is There Any Difference Between the Image Created from a CSBS/CBR Backup and That Created from an ECS?
- Why Can't I Find an ISO Image When I Want to Use It to Create an ECS or Change the OS of an ECS?
- How Do I Create a Full-ECS Image Using an ECS That Has a Spanned Volume?
- Why Is Sysprep Required for Creating a Private Image from a Windows ECS?
- How Do I Handle the Startup Failure of a Windows ECS Created from a Windows Image Generalized by Sysprep?
- What Do I Do If I Cannot Create an Image in ZVHD2 Format Using an API?
- Image Sharing
-
OS
- How Do I Select an OS?
- How Is BIOS Different from UEFI?
- How Do I Delete Redundant Network Connections from a Windows ECS?
- What Do I Do If an ECS Starts Slowly?
- What Do I Do If the One-Click Password Resetting Plug-In Failed to Start?
- What Do I Do If a Windows 7 ECS Equipped with an Intel 82599 NIC Reports an Error in SR-IOV Scenarios?
- Why Can't I Find My Private Image When I Want to Use It to Create an ECS or Change the OS of an ECS?
-
Image Import
- Can I Use Images in Formats not Described in This Document?
- What Are the Impacts If I Do Not Pre-configure an ECS Used to Create a Private Image?
- What Do I Do If I Chose the Wrong OS or System Disk Capacity When Registering a Private Image?
- Why Did My VHD Upload Fail? Why Does the System Say the System Disk in the VHD Image File Is Larger Than What I Specified on the Management Console?
-
Image Export
- Can I Download My Private Images to a Local PC?
- Can I Use the System Disk Image of an ECS on a BMS After I Export It from the Cloud Platform?
- Why Is the Image Size in an OBS Bucket Different from That Displayed in IMS?
- Can I Download a Public Image to My PC?
- Why the Export Option Is Unavailable for My Image?
-
Image Optimization
- Must I Install Guest OS Drivers on an ECS?
- Why Do I Need to Install and Update VirtIO Drivers for Windows?
- What Will the System Do to an Image File When I Use the File to Register a Private Image?
- How Do I Configure an ECS or an Image File Before I Use It to Create an Image?
- What Do I Do If a Windows Image File Is Not Pre-Configured When I Use It to Register a Private Image?
- What Do I Do If a Linux Image File Is Not Pre-Configured When I Use It to Register a Private Image?
- How Do I Enable NIC Multi-Queue for an Image?
- How Do I Configure an ECS to Use DHCPv6?
- How Do I Make a System Disk Image Support Fast ECS Creation?
- Why Did I Fail to Install Guest OS Drivers on a Windows ECS?
- How Do I Install Native Xen and KVM Drivers?
- Image Replication
- Image Deletion
- Image Encryption
- Cloud-Init
-
ECS Creation
- Can I Change the Image of a Purchased ECS?
- Can I Change the Specifications Defined by a Private Image When I Use the Image to Create an ECS?
- Can I Specify the System Disk Capacity When I Create an ECS Using an Image?
- What Do I Do If a Partition Is Not Found During the Startup of an ECS Created from an Imported Private Image?
- What Do I Do If the Disks of a CentOS ECS Created from an Image Cannot Be Found?
- What Do I Do If I Enabled Automatic Configuration During Image Registration for an ECS Created from a Windows Image and Now It Won't Start?
- What Do I Do If an Exception Occurs When I Start an ECS Created from an Image Using UEFI Boot?
-
Driver Installation
- Must I Install Guest OS Drivers on an ECS?
- Why Do I Need to Install and Update VirtIO Drivers for Windows?
- Why Did I Fail to Install Guest OS Drivers on a Windows ECS?
- How Do I Install VirtIO Drivers in Windows?
- How Do I Install Native KVM Drivers in Linux?
- How Do I Install Native Xen and KVM Drivers?
- Image Tags
-
Image Consulting
-
API Reference (Ankara Region)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
- IMS APIs
-
Native OpenStack APIs
-
Image (Native OpenStack APIs)
- Querying Images (Native OpenStack API)
- Querying Image Details (Native OpenStack API)
- Updating Image Information (Native OpenStack API)
- Uploading an Image (Native OpenStack API)
- Deleting an Image (Native OpenStack API)
- Creating Image Metadata (Native OpenStack API)
- Deleting an Image (Native OpenStack API v1.1 - Abandoned and Not Recommended)
- Querying Image Metadata (Native OpenStack API v1 - Abandoned and Not Recommended)
- Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)
- Image Schema (Native OpenStack APIs)
- Image Sharing (Native OpenStack APIs)
- API Version Query (Native OpenStack API)
-
Image (Native OpenStack APIs)
- Examples
- Permission Policies and Supported Actions
- Common Parameters
- Status Codes
- Error Codes
- Change History
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Making an API Request
This section describes the structure of a REST API request, and uses the IAM API for creating an IAM User 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.
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. For example, the endpoint of IAM in region CN-Hong Kong is iam.ap-southeast-1.myhuaweicloud.com. |
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. |
IAM is a global service. You can create an IAM user using the endpoint of IAM in any region. For example, to create an IAM user in the CN-Hong Kong region, obtain the endpoint of IAM (iam.ap-southeast-1.myhuaweicloud.com) for this region and the resource-path (/v3.0/OS-USER/users) in the URI of the API for creating an IAM user. Then construct the URI as follows:
1 |
https://iam.ap-southeast-1.myhuaweicloud.com/v3.0/OS-USER/users |
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
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 for creating an IAM user, the request method is POST. An example request is as follows:
POST https://iam.ap-southeast-1.myhuaweicloud.com/v3.0/OS-USER/users
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.
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 This field is mandatory for requests that use AK/SK authentication in the Dedicated Cloud (DeC) scenario or multi-project scenario. |
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 following shows an example request of the API for creating an IAM user when AK/SK authentication is used:
POST https://iam.ap-southeast-1.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
(Optional) Request Body
This part is optional. A request body is generally sent in a structured format (for example, JSON or XML), which is specified by Content-Type in the request header. It is used to transfer content other than the request header. If the request body contains full-width characters, these characters must be coded in UTF-8.
The request body varies depending on APIs. Certain APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
The following shows an example request (a request body included) of the API for creating an IAM user. You can learn about request parameters and related description from this example. The bold parameters need to be replaced for a real request.
- accountid: account ID of an IAM user
- username: name of an IAM user
- email: email of an IAM user
- password: login password of an IAM user
POST https://iam.ap-southeast-1.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } }
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot