DescribeImages

Last updated: 2021-10-20 16:47:27

1. API Description

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

This API is used to get image information.

A maximum of 20 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 parameter. The value used for this API: DescribeImages.
Version Yes String Common parameter. The value used for this API: 2018-05-25.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of images
Note: this field may return null, indicating that no valid values can be obtained.
ImageInstanceSet Array of ImageInstance Image information list
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the image information

Input Example

https://tke.tencentcloudapi.com/?Action=DescribeImages
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459398"
  }
}

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 Operation failed.
InternalError Internal error.
InternalError.CamNoAuth You do not have permissions.
InternalError.Db DB error.
InternalError.DbAffectivedRows Database error.
InternalError.DbRecordNotFound Record not found.
InternalError.ImageIdNotFound Image not found.
InternalError.UnexceptedInternal Internal error.
InvalidParameter.Param Invalid parameter.
InvalidParameter.RouteTableNotEmpty Route table is not empty.
LimitExceeded Quota limit is exceeded.
MissingParameter Missing parameter.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resource is unavailable
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.