操作指南

API 文档

查询套餐

最近更新时间:2022-04-13 06:54:40

我的收藏

1. 接口描述

接口请求域名: lighthouse.tencentcloudapi.com 。

本接口(DescribeBundles)用于查询套餐信息。

默认接口请求频率限制:5次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBundles。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
BundleIds.N Array of String 套餐 ID 列表。
Offset Integer 偏移量,默认为 0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
Limit Integer 返回数量,默认为 20,最大值为 100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
Filters.N Array of Filter 过滤器列表。
  • bundle-id
  • 按照【套餐 ID】进行过滤。
    类型:String
    必选:否
  • support-platform-type
  • 按照【系统类型】进行过滤。
    取值: LINUX_UNIX(Linux/Unix系统);WINDOWS(Windows 系统)
    类型:String
    必选:否
    每次请求的 Filters 的上限为 10,Filter.Values 的上限为 5。参数不支持同时指定 BundleIds 和 Filters。
    Zones.N Array of String 可用区列表。默认为全部可用区。

    3. 输出参数

    参数名称 类型 描述
    BundleSet Array of Bundle 套餐详细信息列表。
    TotalCount Integer 符合要求的套餐总数,用于分页展示。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询套餐-成功返回

    输入示例

    https://lighthouse.tencentcloudapi.com/?Action=DescribeBundles
    &BundleIds.0=bundle_bw_small1_1
    &BundleIds.1=bundle_ntp_small1_500
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "BundleSet": [
          {
            "BundleId": "bundle_bw_small1_1",
            "CPU": 1,
            "Memory": 1,
            "SystemDiskType": "CLOUD_SSD",
            "SystemDiskSize": 20,
            "InternetMaxBandwidthOut": 1,
            "InternetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
            "MonthlyTraffic": 1,
            "Price": {
              "InstancePrice": {
                "OriginalBundlePrice": 60,
                "OriginalPrice": 60,
                "Discount": 65,
                "DiscountPrice": 39
              }
            },
            "SupportLinuxUnixPlatform": true,
            "SupportWindowsPlatform": false,
            "BundleType": "GENERAL_BUNDLE",
            "BundleSalesState": "AVAILABLE",
            "BundleDisplayLabel": "NORMAL"
          },
          {
            "BundleId": "bundle_ntp_small1_500",
            "CPU": 1,
            "Memory": 1,
            "SystemDiskType": "CLOUD_SSD",
            "SystemDiskSize": 40,
            "InternetMaxBandwidthOut": 3,
            "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
            "MonthlyTraffic": 500,
            "Price": {
              "InstancePrice": {
                "OriginalBundlePrice": 90,
                "OriginalPrice": 90,
                "Discount": 65,
                "DiscountPrice": 58.5
              }
            },
            "SupportLinuxUnixPlatform": true,
            "SupportWindowsPlatform": true,
            "BundleType": "GENERAL_BUNDLE",
            "BundleSalesState": "AVAILABLE",
            "BundleDisplayLabel": "NORMAL"
          }
        ],
        "TotalCount": 2,
        "RequestId": "6d4c966d-bc42-4425-8c98-a39f36c7ad1b"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError.InvalidCommandNotFound 命令 DescribeInstanceLoginKeyPair 无法找到。
    InternalError.RequestError 请求出现错误。
    InternalError.TradeGetPriceFailed 价格获取失败。
    InvalidParameter.BundleIdNotFound 产品未定义的套餐 ID。
    InvalidParameter.FilterValueLimitExceeded 参数非法,Filter 参数中的 Values 取值数量超过允许的最大数量。
    InvalidParameter.InvalidFilter 参数非法,Filter 参数非法。
    InvalidParameter.InvalidFilterInvalidKey 参数非法,Filter 参数中的 Name 取值非法。
    InvalidParameter.InvalidFilterInvalidNameNotStr 参数非法,Filter 参数中的 Name 取值不是字符串。
    InvalidParameter.InvalidFilterNotDict 参数非法,Filter 参数不是字典。
    InvalidParameter.InvalidFilterNotSupportedName 参数非法,Filter 参数中有不支持的 Name。
    InvalidParameter.ParameterConflict 参数非法,参数冲突。
    InvalidParameterValue.Duplicated 参数值非法,不允许包含重复的值。
    InvalidParameterValue.InvalidBlueprintPlatformType 镜像操作系统类型不合法。
    InvalidParameterValue.InvalidConsoleDisplayTypes 控制台显示类型不合法。
    InvalidParameterValue.InvalidZone 参数Zone的取值不合法。
    InvalidParameterValue.LimitExceeded 参数值非法,参数值的数量超过最大限制。
    InvalidParameterValue.Negative 参数值非法,不能为负值。
    InvalidParameterValue.OutOfRange 参数值非法,不在合法范围内。
    InvalidParameterValue.ZoneInvalid 非法的可用区。
    目录