查询带宽明细--云游戏-火山引擎

文档中心

立即注册

导航

查询带宽明细

最近更新时间：2025.01.20 15:42:49首次发布时间：2024.03.26 13:17:25

查询指定时间范围内账号、平台、业务、游戏维度的带宽打点明细数据。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=GetBandwidthDetail&Version=2023-03-18

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetBandwidthDetail`	接口名称。当前 API 的名称为 `GetBandwidthDetail`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。
ProductId	String	否	`80912379813`	业务 ID，不填则默认返回账号维度下的数据。您可在「云游戏控制台-云游戏手游-业务管理」中获取。
GameId	String	否	`901283213`	游戏 ID，查询指定游戏的聚合带宽数据明细，若 `ProductId` 和 `GameId` 都不填则默认返回账号维度的数据。仅当上架游戏后返回。
Aggregate	Integer	否	`60`	数据聚合粒度，单位为分钟，默认值为 5。
StartTime	String	是	`2023-11-30T15:05:00+08:00`	数据查询的起始时间，遵循 RFC 3339 时间格式。起始时间和终止时间的查询间隔最小为 1 天，最大不超过 30 天。格式：2023-11-28T15:05:00+08:00 注意不支持查询当日数据，支持从昨日开始查询。
EndTime	String	是	`2023-11-30T15:06:00+08:00`	数据查询的终止时间，遵循 RFC 3339 时间格式。起始时间和终止时间的查询间隔最小为 1 天，最大不超过 30 天。格式：2023-11-30T15:05:00+08:00

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
BandwidthInfo	Array of BandwidthInfo	`-`	带宽明细

BandwidthInfo

参数	类型	示例值	描述
Bandwidth	Float	`639`	当前时间点的带宽值，单位：Mbps，精确到 6 位小数。
TimeStamp	String	`2023-11-29T12:05:00+08:00`	查询时间点，以聚合维度划分的时间线，如：2023-11-29T12:05:00+08:00

请求示例

GET https://open.volcengineapi.com?Action=GetBandwidthDetail&Version=2023-03-18

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetBandwidthDetail",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "BandwidthInfo": [
            {
                "Bandwidth": 639,
                "TimeStamp": "2023-11-29T12:05:00+08:00"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。