Domain name for API request: cvm.tencentcloudapi.com.
This API is used to view the list of images.
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.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: DescribeImages. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. 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: ImageId in the response. |
| Filters.N | No | Array of Filter | Filters. Each request can have up to 10 Filters and 5 Filters.Values. You cannot specify ImageIds and Filters at the same time. Specific filters:image-id - String - Optional - Filter results by image IDimage-type - String - Optional - Filter results by image type. Valid values:PRIVATE_IMAGE: private image created by the current account PUBLIC_IMAGE: public image created by Tencent Cloud SHARED_IMAGE: image shared with the current account by another account. |
| 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 |
| 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, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the information of an image by the image ID.
GET https://cvm.tencentcloudapi.com/?Action=DescribeImages
&Filters.0.Name=image-id
&Filters.0.Values.0=img-pmqg1cw7
&<Common request parameters>{
"Response": {
"ImageSet": [
{
"ImageId": "img-pmqg1cw7",
"ImageType": "PUBLIC_IMAGE",
"ImageName": "CentOS 6.6 32-bit",
"ImageDescription": "CentOS 6.6 32-bit"
}
],
"TotalCount": 1,
"RequestId": "5920380e-277a-420a-a221-0caac3eb7159"
}
}This example shows you how to query all private images under an account.
GET https://cvm.tencentcloudapi.com/?Action=DescribeImages
&Filters.0.Name=image-type
&Filters.0.Values.0=PRIVATE_IMAGE
&<Common request parameters>{
"Response": {
"ImageSet": [
{
"ImageId": "img-pmqg1cw7",
"ImageType": "PUBLIC_IMAGE",
"ImageName": "CentOS 6.6 32-bit",
"ImageDescription": "CentOS 6.6 32-bit"
}
],
"TotalCount": 1,
"RequestId": "5920380e-277a-420a-a221-0caac3eb7159"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| 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.InvalidParameterValueLimit | Invalid parameter value. |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| UnauthorizedOperation.PermissionDenied |
Was this page helpful?