Tenant Cloud Compute Cloud Virtual Machine Image APIs DescribeImages

DescribeImages

Last Updated At: 2026-08-02 00:05:20

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (DescribeImages) is used to view the list of images.

  • You can query detailed information of a specified image by specifying an image ID, or query detailed information of an image that meets the filtering criteria by configuring a filter. (This API does not support querying public image IDs.)
  • Specify an offset (Offset) and limit (Limit) to select a portion of the results. Return the first 20 images that meet the criteria by default.

Default interface request rate limit: 10 times per second.

Interface update time: 2022-04-23 09:51:31.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeImages
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
ImageIds No No Array of String List of image IDs, such as img-gvbnzy6f. For the format for array parameters, see API Introduction. You can obtain the image ID in the following ways:
  • Through the ImageId returned by the API DescribeImages.
  • Through the DescribeImages.
    Example: ["img-gvbnzy6f"]
    		•
    Filters No No Array of Filter Filtering criteria. A maximum of filters is 10, and a maximum of Filters.Values is 5. Note: You should not specify ImageIds and Filters at the same time. Optional values include image-id and image-type.
    Example:View
    Offset No No Uint64 Offset, 0 by default. For details of the offset, see API Introduction.
    Example: 0
    Limit No No Uint64 Quantity limit, 20 by default, and the maximum value is 100. For details of the Limit, see API Introduction.
    Example: 20
    InstanceType No No String Filters out the images that do not match the instance type specifications, such as S1.SMALL1 and S1.SMALL2.
    Example: "S1.SMALL1"
    HostIp No No String Host IP, used to filter images when creating CDH instances.
    Example: 12.0.11.22

    3. Output Parameters

    Parameter name Type Description
    ImageSet Array of Image A structure about detailed information of an image, mainly includes the main status and attributes of the image.
    Example:View
    TotalCount Int64 Number of eligible images.
    Example: 1
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidFilter Invalid filter.
    InvalidParameterValue.InvalidParameterValueLimit Parameter value error.
    InvalidParameter.InvalidParameterCoexistImageIdsFilters You should not specify both ImageIds and Filters at the same time.