tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Virtual Machine
    Documentation
    Download PDF

    DescribeImages

    Last updated: 2024-10-22 19:33:26
    Download PDF

      1. API Description

      Domain name for API request: cvm.tencentcloudapi.com.

      This API is used to view the list of images.

      • You specify the image ID or set filters to query the details of certain images.
      • You can specify Offset and Limit to select a certain part of the results. By default, the information on the first 20 matching results is returned.

      A maximum of 40 requests can be initiated per second for this API.

      We recommend you to use API Explorer
      Try it
      API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

      2. Input Parameters

      The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

      Parameter Name Required Type Description
      Action Yes String Common Params. The value used for this API: DescribeImages.
      Version Yes String Common Params. The value used for this API: 2017-03-12.
      Region Yes String Common Params. For more information, please see the list of regions supported by the product.
      ImageIds.N No Array of String List of image IDs, such as img-gvbnzy6f. For the format of array-type parameters, see API Introduction. You can obtain the image IDs in two ways:
    • Call DescribeImages and look for ImageId in the response.
    • View the image IDs in the Image Console.
      		•
      Filters.N No Array of Filter Filters. Each request can have up to 10 Filters, and 5 Filters.Values for each filter. ImageIds and Filters cannot be specified at the same time. See details:

    • image-id

      • Filter by the image ID.

      Type: String

      Optional


    • image-type

      • Filter by the image type.

      Type: String

      Optional

      Options:

      PRIVATE_IMAGE: Private images (images created by this account)

      PUBLIC_IMAGE: Public images (Tencent Cloud official images)

      SHARED_IMAGE: Shared images (images shared by other accounts to this account)


    • image-name

      • Filter by the image name.

      Type: String

      Optional


    • platform

      • Filter by the image operating system, such as CentOS.

      Type: String

      Optional


    • tag-key

      • Filter by the tag key.

      Type: String

      Optional


    • tag-value

      • Filter by the tag value.

      Type: String

      Optional


    • tag:tag-key

      • Filter by the tag key-value pair. Replace “tag-key” with the actual value.

      Type: String

      Optional
      Offset No Integer Offset; default value: 0. For more information on Offset, see API Introduction.
      Limit No Integer Number of results returned; default value: 20; maximum: 100. For more information on Limit, see API Introduction.
      InstanceType No String Instance type, e.g. S1.SMALL1

      3. Output Parameters

      Parameter Name Type Description
      ImageSet Array of Image Information on an image, including its state and attributes.
      TotalCount Integer Number of images meeting the filtering conditions.
      RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

      4. Example

      Example1 Querying an image by the image ID

      This example shows you how to query the information of an image by the image ID.

      Input Example

      POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImages
<Common request parameters>

{
    "Filters": [
        {
            "Values": [
                "img-9qabwvbn"
            ],
            "Name": "image-id"
        }
    ]
}

      Output Example

      {
    "Response": {
        "TotalCount": 1,
        "ImageSet": [
            {
                "ImageId": "img-9qabwvbn",
                "OsName": "CentOS 7.6 64-bit",
                "ImageSize": 50,
                "ImageType": "PUBLIC_IMAGE",
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "ImageState": "NORMAL",
                "ImageSource": "OFFICIAL",
                "ImageName": "CentOS 7.6 64-bit",
                "ImageDescription": "CentOS 7.6 64-bit",
                "ImageCreator": null,
                "SyncPercent": null,
                "IsSupportCloudinit": true,
                "Platform": "CentOS",
                "Architecture": "x86_64",
                "SnapshotSet": []
                "Tags": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ]
            }
        ],
        "RequestId": "db145873-3128-4079-8cec-65e05a7c9f89"
    }
}

      Example2 Querying an image by the image type

      This example shows you how to query all private images under an account.

      Input Example

      POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImages
<Common request parameters>

{
    "Filters": [
        {
            "Values": [
                "PRIVATE_IMAGE"
            ],
            "Name": "image-type"
        }
    ]
}

      Output Example

      {
    "Response": {
        "TotalCount": 408,
        "ImageSet": [
            {
                "OsName": "CentOS 7.4 64-bit",
                "ImageSize": 20,
                "ImageType": "PRIVATE_IMAGE",
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "ImageDescription": "test-image",
                "ImageSource": "CREATE_IMAGE",
                "ImageId": "img-qlzp4oea",
                "ImageName": "test-image",
                "ImageCreator": "3205597606",
                "ImageState": "NORMAL",
                "SyncPercent": null,
                "SnapshotSet": [
                    {
                        "SnapshotId": "snap-gqa37j2p",
                        "DiskUsage": "SYSTEM_DISK",
                        "DiskSize": 20
                    }
                ],
                "Tags": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ],
                "Architecture": "x86_64",
                "Platform": "CentOS",
                "IsSupportCloudinit": true
            }
        ],
        "RequestId": "5908394c-5b3f-42e0-a537-8410553890a5"
    }
}

      5. Developer Resources

      SDK

      TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

      Command Line Interface

      6. Error Code

      The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

      Error Code Description
      FailedOperation.IllegalTagKey The tag key contains invalid characters.
      InvalidFilter Invalid filter.
      InvalidFilterValue.LimitExceeded Filter
      InvalidImageId.Malformed Invalid image ID format.
      InvalidInstanceType.Malformed The specified InstanceType parameter has an invalid format.
      InvalidParameter.InvalidParameterCoexistImageIdsFilters ImageIds and Filters cannot be specified at the same time.
      InvalidParameterValue.InstanceTypeNotFound The specified instance type does not exist.
      InvalidParameterValue.InvalidAppIdFormat Invalid AppID
      InvalidParameterValue.InvalidParameterValueLimit Invalid parameter value.
      InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
      InvalidParameterValue.TagKeyNotFound The specified tag does not exist
      InvalidParameterValue.ZoneNotSupported The availability zone does not support this operation.
      InvalidRegion.NotFound The region cannot be found.
      InvalidZone.MismatchRegion The specified zone does not exist.
      ResourcesSoldOut.SpecifiedInstanceType The specified instance type is sold out.
      UnauthorizedOperation.InvalidToken Check if the token is valid.
      UnauthorizedOperation.PermissionDenied You’re not authorized for the operation. Please check the CAM policy.
      UnsupportedOperation Unsupported operation.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy