DescribeVodDomainRealTimeDetailData - 查询实时访问详细数据

更新时间:
复制 MD 格式

调用本接口查询加速域名的实时访问数据,可查询最近7天内的QPS、带宽、HTTP状态码数据。

接口说明

  • 目前本接口服务地址仅支持:华东 2(上海)

  • 支持批量查询,一次最多查询 20 个域名数据。

  • 单次查询的时间跨度(即 StartTime 和 EndTime 的时间跨度)最大为 10 分钟,数据返回的时间粒度为 1 分钟。

  • 仅支持查询最近 7 天内的数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vod:DescribeVodDomainRealTimeDetailData

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

DomainName

string

要查询的加速域名。

  • 支持批量查询,多个域名之间用半角逗号(,)分隔,一次最多支持 20 个域名查询。

  • 您可以登录视频点播控制台,从左侧导航选择配置管理 > 分发加速配置 > 域名管理,查看您已接入到视频点播的加速域名,或者调用 DescribeVodUserDomains 接口查询加速域名列表。

example.com

StartTime

string

获取数据起始时间点。 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2019-01-23T12:35:12Z

EndTime

string

获取数据的结束时间点。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。

说明

结束时间需大于起始时间,并且结束时间和起始时间相差不超过 10 分钟。

2019-01-23T12:40:00Z

Field

string

指定查询的访问数据类型,可同时指定多个访问数据,多个访问数据之间用半角逗号(,)分隔。取值:

  • qps:每秒访问次数。

  • bps:带宽数据。

  • http_code:HTTP 状态码。

qps

LocationNameEn

string

地域英文名。不传入该参数,默认查询所有地域。

shanghai

IspNameEn

string

运营商英文名。不传入该参数,默认查询所有运营商。

unicom

Merge

string

是否按域名维度返回汇总后的数据。取值:

  • true:是,返回的数据为各域名汇总后的值。

  • false(默认值):否,返回的数据将按域名维度进行分组展示。

false

MergeLocIsp

string

是否按地域和运营商维度返回汇总后的数据。取值:

  • true:是,返回的数据,仅按域名维度进行分组,会汇总各地域和运营商的值。

  • false(默认值):否,返回的数据,按域名、地域、运营商的维度进行分组展示。

true

返回参数

名称

类型

描述

示例值

object

Data

string

返回数据详情。按 JSON 字符串返回,具体结构及字段描述如下:

说明

如对应字段没有数据则不返回该字段。

字段名称类型描述
domain_nameString查询的加速域名。
ispString运营商名称。
locationString地域名称。
qpsLong每秒访问次数。
bpsLong带宽数据,单位:bit/s。
http_codeMapHTTP 状态码详情。键为状态码名称,值为状态码数量。
time_stpString数据时间戳。日期格式按照 ISO8601 表示法,并使用 UTC 时间。

[ { "time_stp": "2018-06-05T20:00:00Z", "domain_name": "example.com", "location": "Guangdong", "isp": "telecom", "qps": 10 }, { "time_stp": "2018-06-05T20:00:00Z", "domain_name": "example.com", "location": "Jiangsu", "isp": "unicom", "qps": 11.1 } ]

RequestId

string

请求 ID。

1710298E-8AFA-5F6D-A3E9-47103C52177D

示例

正常返回示例

JSON格式

{
  "Data": "[\n      {\n            \"time_stp\": \"2018-06-05T20:00:00Z\",\n            \"domain_name\": \"example.com\",\n            \"location\": \"Guangdong\",\n            \"isp\": \"telecom\",\n            \"qps\": 10\n      },\n      {\n            \"time_stp\": \"2018-06-05T20:00:00Z\",\n            \"domain_name\": \"example.com\",\n            \"location\": \"Jiangsu\",\n            \"isp\": \"unicom\",\n            \"qps\": 11.1\n      }\n]",
  "RequestId": "1710298E-8AFA-5F6D-A3E9-47103C52177D"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidTime.Malformed Specified StartTime or EndTime is malformed.
400 InvalidDomainName.Malformed Specified domain name is malformed.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情