All Products
Search
Document Center

Elastic Compute Service:Set an image family for a custom image

Last Updated:Jul 15, 2026

Assign an image family to a custom image during creation or by editing its properties.

Procedure

Set an image family in the console

  1. Set an image family in one of the following ways:

    Enter a custom name to create a new image family, or select an existing one.

    Note

    The name must be 2 to 128 characters in length. It cannot start with a special character, a digit, http://, or https://. It can contain only periods (.), underscores (_), hyphens (-), and colons (:).

  2. (Optional) View the image family.

    1. In the upper-right corner of the image list, click the image.png icon.

    2. In the Image Family section, click a family name to view its images.

Set an image family using an API operation

Call the CreateImage API operation to set an image family when you create a custom image.

  1. Log on to OpenAPI Explorer.

  2. Call the CreateImage operation to create a custom image and set its image family.

    This example creates a custom image from an instance and sets the image family to hangzhou-image. Set the following request parameters:

    • RegionId: The region ID. Example: cn-hangzhou.

    • InstanceId: The instance ID. Example: i-bp117mtgmllecpwl****.

    • ImageFamily: The image family name. Example: hangzhou-image.

    The custom image ID is returned.

    
    {
      "RequestId": "46BC46F8-922C-4419-8B5D-E713F663E00A",
      "ImageId": "m-bp1hxxx"
    }
    
  3. Call the DescribeImages operation to verify the image family of the image created in the previous step.

    Set the following request parameters:

    • RegionId: Same region as the previous step.

    • ImageId: The custom image ID from the previous step.

    The response shows ImageFamily as hangzhou-image.

    
    },
            "Status": "Available",
            "Progress": "100%",
            "Usage": "none",
            "Architecture": "x86_64",
            "ProductCode": "",
            "IsCopied": false,
            "ImageFamily": "hangzhou-image",
            "IsSupportIoOptimized": true,
            "IsSupportCloudinit": true,
            "ImageName": "m-bp1h46wfpjxxx",
            "DiskDeviceMappings": {
                "DiskDeviceMapping": [
                    {
                        "SnapshotId": "s-bp1h4xxx",
                        "Type": "system",
                        "Progress": "",
    

References