获取带宽用量--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取带宽用量

最近更新时间：2024.07.08 16:21:03首次发布时间：2022.02.25 18:58:32

本接口用于获取指定时间范围内的带宽用量。

请求说明

请求方式：GET
请求地址：https://veenedge.volcengineapi.com/?Action=GetBandwidthUsage&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	GetBandwidthUsage	公共参数。该参数表示接口名称。取值：GetBandwidthUsage。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
start_bill_cycle	String	是	2023-04	账单的起始时间。格式为 YYYY-MM。
end_bill_cycle	String	是	2023-04	账单的结束时间。格式为 YYYY-MM。
bill_method	String	否	MonthlyP95	计费方式，取值范围： MonthlyP95（默认值）：按月 95 峰值计费。 DailyPeak：按日峰值计费。如您有日峰值计费或其他方式计费需求，请提交工单。

返回参数

参数	类型	示例值	描述
usages	[]BandwidthData	请参见返回示例	带宽用量信息。

请求示例

GET https://veenedge.volcengineapi.com/?Action=GetBandwidthUsage&Version=2021-04-30
&start_bill_cycle=2023-04
&end_bill_cycle=2023-04
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230530203008851E0F63B632A99B****",
        "Action": "GetBandwidthUsage",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "usages": [
            {
                "bill_cycle": "2023-04",
                "bill_start_time": "2023-04-01",
                "bill_end_time": "2023-04-30",
                "isp": "CTCC",
                "isp_cn": "电信",
                "city_level": "2",
                "city_level_cn": "地区中心",
                "value": 0.004196154519796457
            },
            {
                "bill_cycle": "2023-04",
                "bill_start_time": "2023-04-01",
                "bill_end_time": "2023-04-30",
                "isp": "CMCC",
                "isp_cn": "移动",
                "city_level": "3",
                "city_level_cn": "一般城市",
                "value": 0.07025347980676329
            },
            {
                "bill_cycle": "2023-04",
                "bill_start_time": "2023-04-01",
                "bill_end_time": "2023-04-30",
                "isp": "CTCC",
                "isp_cn": "电信",
                "city_level": "3",
                "city_level_cn": "一般城市",
                "value": 0.00042026666666666656
            },
            {
                "bill_cycle": "2023-04",
                "bill_start_time": "2023-04-01",
                "bill_end_time": "2023-04-30",
                "isp": "CUCC",
                "isp_cn": "联通",
                "city_level": "2",
                "city_level_cn": "地区中心",
                "value": 0.06282949537230799
            },
            {
                "bill_cycle": "2023-04",
                "bill_start_time": "2023-04-01",
                "bill_end_time": "2023-04-30",
                "isp": "CMCC",
                "isp_cn": "移动",
                "city_level": "1",
                "city_level_cn": "北上广",
                "value": 0.017434826666666667
            }
        ]
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。