有奖捉虫:办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 私有网络 > 弹性公网IP相关接口 > 查询指定共享流量包的用量明细

1. 接口描述

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

本接口 (DescribeSpecificTrafficPackageUsedDetails) 用于查询指定 共享流量包 的用量明细。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSpecificTrafficPackageUsedDetails。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
TrafficPackageId String 共享流量包唯一ID
Filters.N Array of Filter 每次请求的Filters的上限为10,Filter.Values的上限为5。详细的过滤条件如下:
  • resource-id - String - 是否必填:否 - (过滤条件)按照抵扣流量资源的唯一 ID 过滤。
  • resource-type - String - 是否必填:否 - (过滤条件)按照资源类型过滤,资源类型包括 CVM 和 EIP
  • OrderField String 排序条件。该参数仅支持根据抵扣量排序,传值为 deduction
    OrderType Integer 排序类型,仅支持0和1,0-降序,1-升序。不传默认为0
    StartTime Timestamp 开始时间。不传默认为当前时间往前推30天
    示例值:2024-02-04 18:04:03
    EndTime Timestamp 结束时间。不传默认为当前时间
    示例值:2024-02-05 17:04:03
    Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 中的相关小节
    示例值:0
    Limit Integer 返回数量,默认为20。关于Limit的更进一步介绍请参考 API 中的相关小节。
    示例值:20

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合查询条件的共享流量包用量明细的总数
    UsedDetailSet Array of UsedDetail 共享流量包用量明细列表
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询某个流量包的用量明细

    查询某个流量包的用量明细。

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeSpecificTrafficPackageUsedDetails
    &TrafficPackageId=tfp-f7a3qh6x
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 0,
            "UsedDetailSet": [
                {
                    "TrafficPackageId": "abc",
                    "TrafficPackageName": "abc",
                    "TotalAmount": {
                        "Value": 1,
                        "FormatValue": 0,
                        "FormatUnit": "abc"
                    },
                    "Deduction": {
                        "Value": 1,
                        "FormatValue": 0,
                        "FormatUnit": "abc"
                    },
                    "RemainingAmount": {
                        "Value": 1,
                        "FormatValue": 0,
                        "FormatUnit": "abc"
                    },
                    "Time": "2020-09-22 00:00:00",
                    "ResourceType": "abc",
                    "ResourceId": "abc",
                    "ResourceName": "abc",
                    "Deadline": "2020-09-22 00:00:00"
                }
            ],
            "RequestId": "abc"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter 参数错误。
    InvalidParameter.InvalidFilter 该过滤规则不合法。
    InvalidParameterValue.Combination 非法入参组合。
    InvalidParameterValue.TrafficPackageId 流量包ID格式错误。
    InvalidParameterValue.TrafficPackageIdMalformed 该流量包ID不合法。
    InvalidParameterValue.TrafficPackageNotFound 未查询到此流量包。