查询带宽包资源

最近更新时间:2018-10-26 15:01:24

1. 接口描述

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

接口用于查询带宽包详细信息,包括带宽包唯一标识ID,类型,计费模式,名称,资源信息等

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBandwidthPackages
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
BandwidthPackageIds.N Array of String 带宽包Id,支持批量
Filters.N Array of Filter 每次请求的Filters的上限为10。参数不支持同时指定BandwidthPackageIdsFilters。详细的过滤条件如下:
  • bandwidth-package_id - String - 是否必填:否 - (过滤条件)按照带宽包的唯一标识ID过滤。
  • bandwidth-package-name - String - 是否必填:否 - (过滤条件)按照 带宽包名称过滤。不支持模糊过滤。
  • network-type - String - 是否必填:否 - (过滤条件)按照带宽包的类型过滤。类型包括'BGP','SINGLEISP'和'ANYCAST'。
  • charge-type - String - 是否必填:否 - (过滤条件)按照带宽包的计费类型过滤。计费类型包括'TOP5_POSTPAID_BY_MONTH'和'PERCENT95_POSTPAID_BY_MONTH'
  • resource.resource-type - String - 是否必填:否 - (过滤条件)按照带宽包资源类型过滤。资源类型包括'Address'和'LoadBalance'
  • resource.resource-id - String - 是否必填:否 - (过滤条件)按照带宽包资源Id过滤。资源Id形如'eip-xxxx','lb-xxxx'
  • resource.address-ip - String - 是否必填:否 - (过滤条件)按照带宽包资源Ip过滤。
  • Offset Integer 查询带宽包偏移量
    Limit Integer 查询带宽包数量限制

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的带宽包数量
    BandwidthPackageSet Array of BandwidthPackage 描述带宽包详细信息
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询带宽包资源

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeBandwidthPackages
    &Filters.0.Name=network-type
    &Filters.0.Values.0=BGP
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "BandwidthPackageSet": [
          {
            "BandwidthPackageId": "bwp-drmwgz9k",
            "BandwidthPackageName": "test",
            "ChargeType": "TOP5_POSTPAID_BY_MONTH",
            "CreatedTime": "2018-07-07T09:12:00Z",
            "NetworkType": "BGP",
            "ResourceSet": [
              {
                "AddressIp": "203.195.149.219",
                "ResourceId": "eip-53wbxk2o",
                "ResourceType": "Address"
              }
            ],
            "Status": "CREATED"
          }
        ],
        "RequestId": "e886604e-6f02-4139-a596-8f959f8dfbe3",
        "TotalCount": 1
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameterValue 参数值不合法。