私有网络查询带宽包资源-API 文档-文档中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBandwidthPackages。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
BandwidthPackageIds.N	否	Array of String	带宽包唯一ID列表示例值：bwp-ofoubyyt
Filters.N	否	Array of Filter	每次请求的`Filters`的上限为10。参数不支持同时指定`BandwidthPackageIds`和`Filters`。详细的过滤条件如下： bandwidth-package-id - String - 是否必填：否 - （过滤条件）按照带宽包的唯一标识ID过滤。 bandwidth-package-name - String - 是否必填：否 - （过滤条件）按照带宽包名称过滤。不支持模糊过滤。 network-type - String - 是否必填：否 - （过滤条件）按照带宽包的类型过滤。类型包括'HIGH_QUALITY_BGP','BGP','SINGLEISP'和'ANYCAST'。 charge-type - String - 是否必填：否 - （过滤条件）按照带宽包的计费类型过滤。计费类型包括: 'TOP5_POSTPAID_BY_MONTH':按月后付费TOP5计费 'PERCENT95_POSTPAID_BY_MONTH':按月后付费月95计费 'ENHANCED95_POSTPAID_BY_MONTH':按月后付费增强型95计费 'FIXED_PREPAID_BY_MONTH':包月预付费计费 ‘PEAK_BANDWIDTH_POSTPAID_BY_DAY’: 后付费日结按带宽计费 resource.resource-type - String - 是否必填：否 - （过滤条件）按照带宽包资源类型过滤。资源类型包括'Address'和'LoadBalance' resource.resource-id - String - 是否必填：否 - （过滤条件）按照带宽包资源Id过滤。资源Id形如'eip-xxxx','lb-xxxx' resource.address-ip - String - 是否必填：否 - （过滤条件）按照带宽包资源Ip过滤。 tag-key - String - 是否必填：否 - （过滤条件）按照标签键进行过滤。 tag-value - String - 是否必填：否 - （过滤条件）按照标签值进行过滤。 tag:tag-key - String - 是否必填：否 - （过滤条件）按照标签键值对进行过滤。tag-key使用具体的标签键进行替换。
Offset	否	Integer	查询带宽包偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小结。示例值：0
Limit	否	Integer	查询带宽包返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小结。示例值：20

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的带宽包数量示例值：1
BandwidthPackageSet	Array of BandwidthPackage	描述带宽包详细信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询带宽包资源

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBandwidthPackages
<公共请求参数>

{
    "Filters": [
        {
            "Values": [
                "BGP"
            ],
            "Name": "network-type"
        }
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "BandwidthPackageSet": [
            {
                "BandwidthPackageId": "bwp-p6am50q0",
                "BandwidthPackageName": "gongxiang1",
                "Status": "CREATED",
                "NetworkType": "BGP",
                "Egress": "center_egress1",
                "ChargeType": "FIXED_PREPAID_BY_MONTH",
                "CreatedTime": "2019-12-31T16:48:49Z",
                "Deadline": "2023-02-06T06:42:20Z",
                "ResourceSet": [
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-hbhcbwci",
                        "AddressIp": "134.175.210.185"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-bksqvcue",
                        "AddressIp": "193.112.158.4"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-rlwrl9zg",
                        "AddressIp": "193.112.128.149"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-0a0z6e86",
                        "AddressIp": "193.112.214.231"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-loq78a2u",
                        "AddressIp": "193.112.214.146"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-9b23ko6g",
                        "AddressIp": "193.112.195.106"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-l3utrirm",
                        "AddressIp": "193.112.214.252"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-biawxrrg",
                        "AddressIp": "193.112.161.62"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-gm8dcbmw",
                        "AddressIp": "129.204.145.2"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-f3yjemhw",
                        "AddressIp": "134.175.169.60"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-oahxub36",
                        "AddressIp": "106.53.87.77"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-ej9oasck",
                        "AddressIp": "193.112.186.94"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-iivgnxr6",
                        "AddressIp": "106.52.155.79"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-9pva2ne6",
                        "AddressIp": "106.52.167.45"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-fqexkiku",
                        "AddressIp": "129.204.251.201"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-dorh1ejy",
                        "AddressIp": "106.55.92.150"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-pdxzxuzs",
                        "AddressIp": "42.194.204.43"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-26tl14zo",
                        "AddressIp": "106.52.248.58"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-1n624fs0",
                        "AddressIp": "106.55.63.197"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-j4s0mcug",
                        "AddressIp": "106.55.92.154"
                    }
                ],
                "Bandwidth": 500
            }
        ],
        "RequestId": "e0ee5afd-a684-4a4c-9fff-ef5d626aed46"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameter.InvalidFilter	该过滤规则不合法。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.BandwidthPackageIdMalformed	带宽包ID不正确。
InvalidParameterValue.InvalidBandwidthPackageChargeType	无效的带宽包计费方式。
UnsupportedOperation	操作不支持。

查询带宽包资源

本页目录：