查询计费用量DescribeBillingDetail--全站加速-火山引擎

文档中心

立即注册

导航

查询计费用量DescribeBillingDetail

最近更新时间：2024.06.27 17:29:03首次发布时间：2024.06.27 10:44:01

API说明

API名称：DescribeBillingDetail。
API域名：open.volcengineapi.com。
API描述：查询计费用量。

注意

仅允许查询账号计费方式对应的计费用量信息。例如：您账号的计费方式是按峰值带宽计费，那么您无法查询流量的计费用量信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=DescribeBillingDetail&Version=2021-04-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeBillingDetail`。
Version	String	是	接口版本。当前 API 的版本为 `2021-04-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
StartTime	String	是	指定查询的开始时间，开始时间和结束时间最大查询跨度不超过31天。	`2024-06-18 14:47:48`
EndTime	String	是	指定查询的结束时间，开始时间和结束时间最大查询跨度不超过31天。	`2024-06-18 14:47:48`
Interval	Integer	否	指定查询的时间粒度，单位是秒。支持取值: 300（5分钟）：查询的时间粒度为5分钟，默认的时间粒度。 3600（1小时）：查询的时间粒度为1小时。 86400（1天）：查询的时间粒度为1天。	`300`
ProjectName	String[]	否	按照项目的维度查询计费用量情况，您可指定一个或多个项目。不指定项目时，默认查询账号维度的数据。	`["TEST"]`
Domains	String[]	否	按照域名的维度查询计费用量情况，您可指定一个或多个加速域名。不指定域名时，默认查询账号维度的数据。	`["www.test.com"]`
Metric	String	是	指定一个要查询的指标，不允许为空。支持取值： traffic：流量。 bandwidth：带宽。 requests：总请求数。 static_requests：动态请求数。 dynamic_requests：静态请求数。说明查询 bandwidth（带宽）时，Interval 的值只能为300，即查询的时间粒度只能设置为300。	`traffic`
Protocol	String[]	否	指定查询的客户端请求对应的应用层或传输层协议，为空时表示查询所有协议汇总的计费数据。支持取值： http https quic ws：websocket 协议，仅支持查询指标 traffic（流量）和 bandwidth（带宽）。	`["http"]`
Area	String	否	指定一个查询的计费区域。不传或为空时，默认查询的计费区域是中国内地。支持取值： CHN：中国内地。 AP1：亚太一区。 AP2：亚太二区。 AP3：亚太三区。 NA：北美。 SA：南美。 EU：欧洲。 ME：中东、非洲。 Global：全球区域。 Overseas：海外全部区域，不包括中国内地。	`CHN`

返回参数

参数名称	数据类型	参数说明	示例
Values	Object[]	具体的计费数据。	`-`

请求示例

POST https://open.volcengineapi.com?Action=DescribeBillingDetail&Version=2021-04-01
{
    "StartTime": "2024-05-28 14:47:48",
    "EndTime": "2024-06-18 14:47:48",
    "Metric": "traffic",
    "Interval":300
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202406*****841A5FF6F389DAB5D1356BB",
        "Action": "DescribeBillingDetail",
        "Version": "2021-04-01",
        "Service": "dcdn"
    },
    "Result": {
        "values": [
            {
                "Timestamp": 1716878700,
                "TimeDate": "2024-05-28 14:45:00",
                "Value": 0
            },
            ......
            {
                "Timestamp": 1718693100,
                "TimeDate": "2024-06-18 14:45:00",
                "Value": 0
            }
        ]
    }
}