私有网络查询共享流量包

1. 接口描述

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

本接口 (DescribeTrafficPackages) 用于查询共享流量包详细信息，包括共享流量包唯一标识ID，名称，流量使用信息等

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTrafficPackages。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
TrafficPackageIds.N	否	Array of String	共享流量包ID，支持批量示例值：["tfp-g67jlh1j"]
Filters.N	否	Array of Filter	每次请求的`Filters`的上限为10。参数不支持同时指定`TrafficPackageIds`和`Filters`。详细的过滤条件如下： traffic-package_id - String - 是否必填：否 - （过滤条件）按照共享流量包的唯一标识ID过滤。 traffic-package-name - String - 是否必填：否 - （过滤条件）按照共享流量包名称过滤。不支持模糊过滤。 status - String - 是否必填：否 - （过滤条件）按照共享流量包状态过滤。可选状态：[AVAILABLE\|EXPIRED\|EXHAUSTED]
Offset	否	Integer	分页参数示例值：0
Limit	否	Integer	分页参数示例值：20

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	按照条件查询出来的流量包数量示例值：2
TrafficPackageSet	Array of TrafficPackage	流量包信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询某一个账号所有的共享流量包信息

查询某一个账号所有的共享流量包信息。

输入示例

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

{}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "TrafficPackageSet": [
            {
                "TrafficPackageId": "tfp-g67jlh1j",
                "TrafficPackageName": "未命名",
                "TotalAmount": 10,
                "RemainingAmount": 10,
                "Status": "AVAILABLE",
                "CreatedTime": "2022-08-31T11:42:37Z",
                "Deadline": "2022-09-30T11:42:36Z",
                "DeductType": "FULL_TIME",
                "UsedAmount": 0,
                "TagSet": [
                    {
                        "Key": "name",
                        "Value": "Sam"
                    }
                ]
            }
        ],
        "RequestId": "e92ac36b-db69-4329-b030-9276b88d93c4"
    }
}

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.TrafficPackageIdMalformed	该流量包ID不合法。

查询共享流量包

本页目录：