DescribeDomainTopReferVisit_数据监控类接口_新版API参考

调用该接口前，请您注意：

如果您不指定StartTime和EndTime时，默认读取过去24小时的数据；指定StartTime和EndTime时，按指定的起止时间查询。
该接口的的计算数据粒度为5分钟。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDomainTopReferVisit	操作接口名，系统规定参数，取值：DescribeDomainTopReferVisit。
DomainName	String	是	example.com	加速域名，多个域名用逗号（,）分隔。
StartTime	String	否	2019-12-21T12:00:00Z	获取数据起始时间。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	否	2019-12-22T12:00:00Z	获取数据结束时间点。日期格式按照ISO8601表示法，并使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。结束时间大于起始时间。
SortBy	String	否	pv	排序方式。 traf：流量。 pv（默认值）：访问次数。
Percent	String	否	0.5	百分比。取值：0~1。

返回数据


名称	类型	示例值	描述
RequestId	String	95994621-8382-464B-8762-C708E73568D1	请求ID。
DomainName	String	test.com	加速域名信息。
StartTime	String	2019-12-21T12:00:00Z	查询指定日期。
TopReferList	Array		全部热门页面列表。
ReferDetail	String	live-xxx.com	完整的热门页面地址。
VisitData	String	3	访问次数。
VisitProportion	Float	0.5	访问占比。
Flow	String	200	流量。单位：byte。
FlowProportion	Float	0.5	流量占比。

示例

请求示例

http://cdn.aliyuncs.com?Action=DescribeDomainTopReferVisit
&DomainName=test.com
&StartTime=2019-12-21T12:00:00Z
&EndTime=2019-12-22T12:00:00Z
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDomainTopReferVisitResponse>
  <TopReferList>
        <ReferList>
              <Flow>1557043</Flow>
              <VisitProportion>0.9078341013824884</VisitProportion>
              <VisitData>591</VisitData>
              <ReferDetail>-</ReferDetail>
              <FlowProportion>0.07801388057582173</FlowProportion>
        </ReferList>
        <ReferList>
              <Flow>18397394</Flow>
              <VisitProportion>0.08602150537634409</VisitProportion>
              <VisitData>56</VisitData>
              <ReferDetail>live-xxx.com</ReferDetail>
              <FlowProportion>0.9217806434519402</FlowProportion>
        </ReferList>
        <ReferList>
              <Flow>4101</Flow>
              <VisitProportion>0.006144393241167435</VisitProportion>
              <VisitData>4</VisitData>
              <ReferDetail>live-xxx.com</ReferDetail>
              <FlowProportion>0.00020547597223804668</FlowProportion>
        </ReferList>
  </TopReferList>
  <RequestId>BA64068A-D73C-4613-8AAB-E9374F78FB95</RequestId>
  <DomainName>test.com</DomainName>
  <StartTime>2019-12-21T12:00:00Z</StartTime>
</DescribeDomainTopReferVisitResponse>

JSON 格式

{
	"TopReferList": {
		"ReferList": [
			{
				"Flow": 1557043,
				"VisitProportion": "0.9078341013824884",
				"VisitData": 591,
				"ReferDetail": "-",
				"FlowProportion": "0.07801388057582173"
			},
			{
				"Flow": 18397394,
				"VisitProportion": "0.08602150537634409",
				"VisitData": 56,
				"ReferDetail": "live-xxx.com",
				"FlowProportion": "0.9217806434519402"
			},
			{
				"Flow": 4101,
				"VisitProportion": "0.006144393241167435",
				"VisitData": 4,
				"ReferDetail": "live-xxx.com",
				"FlowProportion": "0.00020547597223804668"
			}
		]
	},
	"RequestId": "BA64068A-D73C-4613-8AAB-E9374F78FB95",
	"DomainName": "test.com",
	"StartTime": "2019-12-21T12:00:00Z"
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	起始时间格式错误。日期格式请参考所调用API的帮助文档说明。
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	结束时间格式错误。日期格式请参考所调用API的帮助文档说明。
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	开始时间设置错误，请检查更新后重试。

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