字段	类型	是否必填	示例	描述
Action	String	是	DescribeDomainUsageData	系统规定参数。取值：DescribeDomainUsageData。
DomainName	String	否	xxx.com	加速域名。若参数为空,值会被默认设置为all，默认返回所有加速域名合并后数据。5minutes支持批量查询(去重),hour和day只支持单个查询，多个用半角逗号（,）分隔。(主域名)
StartTime	String	是	2022-01-01T10:20:00Z	获取数据起始时间点。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
EndTime	String	是	2022-01-01T12:20:00Z	获取数据结束时间点，需晚于起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
Interval	String	否	day	统计时间粒度。取值： 5minutes：5分钟 (最大时间范围1天,最长过去100天) hour：小时(最大时间范围7天,最长过去100天) day：天(最大时间范围31天, 最长过去100天) 默认按时间跨度决定，小于等于1小时以5分钟为粒度，小于等于1天以1小时为粒度，大于1天则以天为粒度。
Percentile	String	否	DomesticBps	查询95峰值, 可选值：DomesticBps, OverseaBps, TotalBps, 返回值在返回记录UsageDataItem对应字段中

2. 返回参数

字段	类型	描述
DomainName	String	加速域名。若参数为空，默认返回所有加速域名合并后数据。支持批量查询(去重)，多个用半角逗号（,）分隔。(主域名)
Interval	String	统计时间粒度。取值： 5minutes：5分钟 (最大时间范围1天,最长过去100天) hour：小时。(最大时间范围7天,最长过去100天) day：天。(最大时间范围31天, 最长过去100天) 默认按时间跨度决定，小于等于1小时以5分钟为粒度，小于等于1天以1小时为粒度，大于1天则以天为粒度。
UsageData	Array of UsageDataItem	流量或带宽用量数据。

UsageDataItem

参数名称	类型	示例值	描述
TimeStamp	String	2022-01-01T10:00:00Z	时间片起始时刻。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
TotalBps	String	244642.22	总带宽。单位：bit/second
OverseaBps	String	122321.11	海外带宽。单位：bit/second
DomesticBps	String	122321.11	国内带宽。单位：bit/second
TotalTraffic	String	244642.22	总流量。单位：byte
DomesticTraffic	String	122321.11	国内流量。单位：byte
OverseaTraffic	String	122321.11	海外流量。单位：byteAPI示例

3. 示例

3.1 请求示例

curl -X POST 'https://vod.streamlakeapi.com/?Action=DescribeDomainUsageData' \
-H 'Content-Type: application/json' \
-d '{"EndTime":"2015-12-10T12:20:00Z","StartTime":"2015-12-10T10:20:00Z"}'

3.2 返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
  "ResponseMeta": {
    "RequestId":"CixgpmAFOYcAAAAAAAAAAw",
    "ErrorCode":"",
    "ErrorMessage":""
  },
  "ResponseData": {
    "DomainName": "xxx.com",
    "Interval" : 300,
    "UsageData" : [
      {
        "TotalBps" : "222222",
        "OverseaBps" : "111111",
        "DomesticBps" : "111111",
        "TotalTraffic" : "244642.22",
        "DomesticTraffic" : "122321.11",
        "OverseaTraffic" : "122321.11",
        "TimeStamp" : "2022-02-21T04:55:00Z"
      }, {
        "TotalBps" : "222222",
        "OverseaBps" : "111111",
        "DomesticBps" : "111111",
        "TotalTraffic" : "244642.22",
        "DomesticTraffic" : "122321.11",
        "OverseaTraffic" : "122321.11",
        "TimeStamp" : "2022-02-21T04:55:00Z"
      } 
    ]  
}

4. 错误码

下表列举了本接口特有的错误码。

错误代码	错误信息	HTTP 状态码	说明
InvalidArgument	Invalid Parameter.	400	参数错误。
InvalidArgument	Invalid Parameter Area.	400	Area参数错误。
InvalidArgument	Invalid Parameter Field.	400	Field参数错误。
InvalidArgument	Invalid Parameter StartTime.	400	StartTime参数错误。
InvalidArgument	Invalid Parameter EndTime.	400	EndTime参数错误。
InvalidArgument	StartTime and EndTime range should less than 1 month.	400	EndTime和StartTime差值不能超过31天。
InvalidArgument	Invalid Parameter Interval.	400	Interval参数错误。
InvalidArgument	Only one DomainName can be queried for hour	400
InvalidArgument	Only one DomainName can be queried for day	400

该篇文档内容是否对您有帮助？

有帮助没帮助

关于我们

支持与服务

法律支持

联系我们

友情链接