查看实例流量包详情

最近更新时间:2024-03-12 01:38:00

我的收藏

1. 接口描述

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

本接口(DescribeInstancesTrafficPackages)用于查询一个或多个实例的流量包详情。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstancesTrafficPackages。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 实例 ID 列表。每次请求批量实例的上限为 100。可通过DescribeInstances接口返回值中的InstanceId获取。
示例值:["lhins-7h98ep3z"]
Offset Integer 偏移量,默认为 0。
示例值:0
Limit Integer 返回数量,默认为 20,最大值为 100。
示例值:2

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的实例流量包详情数量。
示例值:2
InstanceTrafficPackageSet Array of InstanceTrafficPackage 实例流量包详情列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例流量包详情

输入示例

https://lighthouse.tencentcloudapi.com/?Action=DescribeInstancesTrafficPackages
&Limit=2
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "InstanceTrafficPackageSet": [
            {
                "InstanceId": "lhins-7h98ep3z",
                "TrafficPackageSet": [
                    {
                        "TrafficPackageId": "lhtfp-o1wtyyvx",
                        "TrafficUsed": 5905577,
                        "TrafficPackageTotal": 536870912000,
                        "TrafficPackageRemaining": 536865006423,
                        "TrafficOverflow": 0,
                        "StartTime": "2020-06-28T08:15:18Z",
                        "EndTime": "2020-07-28T08:15:17Z",
                        "Deadline": "2020-07-28T08:15:18Z",
                        "Status": "NETWORK_NORMAL"
                    }
                ]
            },
            {
                "InstanceId": "lhins-abtdx7eb",
                "TrafficPackageSet": [
                    {
                        "TrafficPackageId": "lhtfp-4noj8p75",
                        "TrafficUsed": 3435972,
                        "TrafficPackageTotal": 536870912000,
                        "TrafficPackageRemaining": 536867476028,
                        "TrafficOverflow": 0,
                        "StartTime": "2020-06-28T08:08:57Z",
                        "EndTime": "2020-07-28T08:08:56Z",
                        "Deadline": "2020-07-28T08:08:57Z",
                        "Status": "NETWORK_NORMAL"
                    }
                ]
            }
        ],
        "RequestId": "7839b8ee-f5a4-4a67-b1ab-15fb35b1e2fe"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.DescribeInstancesTrafficPackagesFailed 查询流量包失败。
InternalError.DescribeInstancesTrafficPackagesFailed 查询实例流量包错误。
InvalidParameterValue.Duplicated 参数值非法,不允许包含重复的值。
InvalidParameterValue.InstanceIdMalformed 参数值非法,实例 ID 格式非法。
InvalidParameterValue.LimitExceeded 参数值非法,参数值的数量超过最大限制。
InvalidParameterValue.Negative 参数值非法,不能为负值。
InvalidParameterValue.OutOfRange 参数值非法,不在合法范围内。
UnauthorizedOperation.NoPermission 无权限。