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

1. 接口描述

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

本接口 (DescribeBandwidthPackageResources) 用于根据共享带宽包唯一ID查询共享带宽包内的资源列表，支持按条件过滤查询结果和分页查询。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBandwidthPackageResources。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
BandwidthPackageId	是	String	标识共享带宽包的唯一 ID 列表。共享带宽包唯一 ID 形如：`bwp-11112222`。示例值：bwp-7umnal1o
Filters.N	否	Array of Filter	每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`AddressIds`和`Filters`。详细的过滤条件如下： resource-id - String - 是否必填：否 - （过滤条件）按照共享带宽包内资源的唯一 ID 过滤。共享带宽包内资源唯一 ID 形如：eip-11112222。 resource-type - String - 是否必填：否 - （过滤条件）按照共享带宽包内资源类型过滤，目前仅支持弹性IP 和负载均衡两种类型，可选值为 Address 和 LoadBalance。
Offset	否	Integer	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 简介中的相关小节。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。示例值：20

3. 输出参数

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

4. 示例

示例1 查询共享带宽包内的资源列表

输入示例

https://vpc.tencentcloudapi.com/?Action=DescribeBandwidthPackageResources
&BandwidthPackageId=bwp-7umnal1o
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "ResourceSet": [
            {
                "ResourceType": "Address",
                "ResourceId": "eip-60z7i46d",
                "AddressIp": "139.199.XX.XX"
            },
            {
                "ResourceType": "Address",
                "ResourceId": "eip-d97psd1o",
                "AddressIp": "139.198.XX.XX"
            }
        ],
        "RequestId": "ecaa7a90-a2fd-4fa3-8bf8-7d0723c95a99"
    }
}

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	参数错误。
InvalidParameter.InvalidFilter	该过滤规则不合法。
InvalidParameterValue.BandwidthPackageIdMalformed	带宽包ID不正确。
InvalidParameterValue.BandwidthPackageNotFound	未查询到该带宽包。
InvalidParameterValue.Illegal	资源格式错误

查询共享带宽包内的资源

本页目录：