Release Notes and Announcements

Image Release Notes

Announcements

Product Introduction

Overview

Basic Concepts

Strengths

Scenarios

Use Limits

Region and Network Connectivity

Product Comparison

User Guide

Billing

Billing Overview

Instance Package

Pricing Details

Purchase Methods

Configuration Adjustment (for Upgrade Only)

Overdue Payments

Refund

Getting Started

One-Click Application Creation Using Lighthouse

Quick Instance Creation

User Guide

Instances

Cloud Disks

Images

Firewall

Private Network Interconnection

Data Backup and Restoration Using Snapshots

Cloud Access Management

OPS and Monitoring

File Transfer

Use Cases

Website Building

Development Environment Building

Cloud Storage System Building

E-commerce Platform Building

Personal Live Streaming Room Building

FTP Service Building

SSL Certificate Installation

Troubleshooting

Windows Instance: RDP Connection to the Remote Computer Fails

Windows Instance: Offline Password Resetting Fails or Invalid

Linux/Windows Instance: Online Password Resetting Fails or Invalid

API Documentation

History

Introduction

API Category

Making API Requests

Image APIs

Firewall APIs

Key APIs

Instance APIs

Snapshot APIs

CCN APIs

Other APIs

Cloud Disk APIs

Scene APIs

Package APIs

Quota APIs

Region APIs

Data Types

Error Codes

FAQs

Agreements

Data Processing And Security Agreement

DescribeBundles

PDF

Focus Mode

Font Size

Last updated: 2026-03-26 22:26:32

1. API Description

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

This API is used to query the information of a package.

A maximum of 5 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: DescribeBundles.
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.
BundleIds.N	No	Array of String	List of bundle ids. the maximum is 100 per request for batch packages. you can get the BundleId in the return value from the API DescribeBundles.
Offset	No	Integer	Offset. Default value: 0. For more information on `Offset`, please see the relevant section in Overview.
Limit	No	Integer	Number of returned results. Default value: 20. Maximum value: 100. For more information on `Limit`, please see the relevant section in the API Overview.
Filters.N	No	Array of Filter	Filter list. bundle-id Filter by [bundle id]. Type: String. Required: No `support-platform-type` Filter by the system type. Value: LINUX_UNIX (LINUX/UNIX system); WINDOWS (WINDOWS systems). Type: String. Required: No bundle-type Filter by [package type]. Valid values: GENERAL_BUNDLE (GENERAL BUNDLE); STORAGE_BUNDLE (STORAGE BUNDLE); ENTERPRISE_BUNDLE (ENTERPRISE BUNDLE); EXCLUSIVE_BUNDLE (dedicated BUNDLE); BEFAST_BUNDLE (SPEED BUNDLE); STARTER_BUNDLE (STARTER BUNDLE); CAREFREE_BUNDLE (CAREFREE BUNDLE); RAZOR_SPEED_BUNDLE (RAZOR SPEED BUNDLE). Type: String. Required: No bundle-state Filter by [package status]. Valid values: ONLINE, OFFLINE. Type: String. Required: No The maximum number of `Filters` per request is 10, and the maximum number of `Filter.Values` is 5. the parameter does not support specifying both `BundleIds` and `Filters`.
Zones.N	No	Array of String	AZ list. default to all availability zones. AZs can be queried through the API DescribeZones .

3. Output Parameters

Parameter Name	Type	Description
BundleSet	Array of Bundle	List of package details.
TotalCount	Integer	Total number of eligible packages, which is used for pagination.
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 bundles

This example shows you how to query the information of specific bundles.

Input Example

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

{
    "BundleIds": [
        "bundle_ntp_small1_500",
        "bundle_bw_small1_1"
    ]
}

Output Example

{
    "Response": {
        "BundleSet": [
            {
                "BundleId": "bundle2022_gen_02",
                "CPU": 2,
                "Memory": 2,
                "SystemDiskType": "CLOUD_SSD",
                "SystemDiskSize": 50,
                "InternetMaxBandwidthOut": 5,
                "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                "MonthlyTraffic": 500,
                "Price": {
                    "InstancePrice": {
                        "Currency": "USD",
                        "OriginalBundlePrice": 60.0,
                        "OriginalPrice": 60.0,
                        "Discount": 66.229933,
                        "DiscountPrice": 39.74
                    }
                },
                "SupportLinuxUnixPlatform": true,
                "SupportWindowsPlatform": true,
                "BundleType": "GENERAL_BUNDLE",
                "BundleTypeDescription": "Standard",
                "BundleSalesState": "AVAILABLE",
                "BundleDisplayLabel": "NORMAL"
            }
        ],
        "TotalCount": 1,
        "RequestId": "b2563b1d-e93f-4e05-9c6f-096e0c403add"
    }
}

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.DescribeBundlesFailed	Query package failed.
FailedOperation.RequestError	A request error occurred.
FailedOperation.TradeGetPriceFailed	Failed to query the price.
InternalError.InvalidCommandNotFound	The command is not found.
InternalError.RequestError	There was an error in the request.
InternalError.TradeGetPriceFailed	Failed to get the price.
InvalidParameter.BundleIdNotFound	Undefined service package ID.
InvalidParameter.Conflict	Parameters conflicted.
InvalidParameter.FilterValueLimitExceeded	Invalid parameter: the number of `Values` in the `Filter` parameter exceeds the allowed maximum number.
InvalidParameter.InvalidFilter	Invalid parameter: the `Filter` parameter is invalid.
InvalidParameter.InvalidFilterInvalidKey	Invalid parameter: the value of `Name` in the `Filter` parameter is invalid.
InvalidParameter.InvalidFilterInvalidNameNotStr	Invalid parameter: the value of `Name` in the `Filter` parameter is not a string.
InvalidParameter.InvalidFilterNotDict	Invalid parameter: the `Filter` parameter is not a dictionary.
InvalidParameter.InvalidFilterNotSupportedName	Invalid parameter: there are unsupported `Name` values in the `Filter` parameter.
InvalidParameter.ParameterConflict	Invalid parameter: the parameters conflict.
InvalidParameterValue.Duplicated	Invalid parameter value: duplicate values are not allowed.
InvalidParameterValue.InvalidBlueprintPlatformType	The type of the image OS is invalid.
InvalidParameterValue.InvalidConsoleDisplayTypes	The console display type is invalid.
InvalidParameterValue.InvalidZone	Invalid `Zone` value.
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.ZoneInvalid	Invalid AZ.

Help and Support

Was this page helpful?

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

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Tencent Cloud Lighthouse