tencent cloud

1. API Description

Domain name for API request: cvm.intl.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.

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.

3. Output Parameters

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.intl.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.intl.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.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

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