DescribeImagesToShare

Download PDF

Last updated:2026-01-13 21:47:52

DescribeImagesToShare

Last updated: 2026-01-13 21:47:52

Download PDF

1. API Description

Domain name for API request: lighthouse.intl.tencentcloudapi.com.

This API is used to query the list of Cloud Virtual Machine (CVM) custom images and share the images to Tencent Cloud Lighthouse (Lighthouse).

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 Params. The value used for this API: DescribeImagesToShare.
Version	Yes	String	Common Params. The value used for this API: 2020-03-24.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ImageIds.N	No	Array of String	List of CVM image IDs, which can be obtained through the ImageId in the returned value of the DescribeImages API.
Offset	No	Integer	Offset. The default value is 0. For more information on `Offset`, see the relevant section in API Introduction.
Limit	No	Integer	Number of returned results. The default value is 20, and the maximum value is 100. For more information on `Limit`, see the relevant section in API Introduction.
Filters.N	No	Array of Filter	Filter list. image-id : filter by [CVM image ID]. Type: string. Required: no. image-name : filter by [CVM image name]. Type: string. Required: no. image-type : filter by [CVM image type]. Type: string. Required: no. Valid values: PRIVATE_IMAGE: private image (image created by the account). PUBLIC_IMAGE: public image (Tencent Cloud official image). SHARED_IMAGE: shared image (image shared by other accounts to this account). The maximum number of Filters per request is 10, and the maximum number of Filter.Values per request is 5. ImageIds and Filters cannot be specified simultaneously for parameters.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of images that meet the conditions.
ImageSet	Array of Image	List of CVM image detailed information.
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

Input Example

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

{
    "ImageIds": [
        "img-cs2rrmp0"
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "ImageSet": [
            {
                "ImageId": "img-cs2rrmp0",
                "ImageName": "ubuntu",
                "ImageDescription": "ubuntu",
                "ImageSize": 50,
                "ImageSource": "CREATE_IMAGE",
                "ImageClass": "SystemImage",
                "ImageState": "NORMAL",
                "IsSupportCloudinit": true,
                "Architecture": "x86_64",
                "OsName": "Ubuntu Server 20.04 LTS 64bit",
                "Platform": "Ubuntu",
                "CreatedTime": "2021-07-23T08:49:36Z",
                "IsShareable": true,
                "UnshareableReason": ""
            }
        ],
        "RequestId": "c5aafa9d-20e4-400e-852c-b800f607dd91"
    }
}

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

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.

Error Code	Description
FailedOperation	Operation failed.
FailedOperation.DescribeImagesFailed	Failed to query the CVM image list.
FailedOperation.RequestError	A request error occurred.
InvalidParameter.InvalidFilter	Invalid parameter: the `Filter` parameter is invalid.
InvalidParameterValue.Duplicated	Invalid parameter value: duplicate values are not allowed.
InvalidParameterValue.InvalidImageIdMalformed	The image ID format is invalid.
InvalidParameterValue.LimitExceeded	Invalid parametric value: the number of parameter values exceeds the upper limit.
InvalidParameterValue.Negative	Invalid parametric value: it cannot be negative.
InvalidParameterValue.OutOfRange	Invalid parametric value: it is not within the valid range.
InvalidParameterValue.TooLong	The length of the parameter value exceeds the upper limit.
ResourceNotFound.RoleNotFound	The service role does not exist. Please add it to the account.
UnauthorizedOperation.NoPermission	No permission.
UnsupportedOperation.AssumeRoleFailed	Failed to obtain role authorization. Grant authorizations to the Lighthouse-related role and try again.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud