Queries frequently requested URLs of an accelerated domain name on a specified day.

Note
  • If you do not set the StartTime parameter, data within the previous day is queried.
  • You can specify only one accelerated domain or all the accelerated domains that belong to your Alibaba Cloud account.
  • You can query data within the last 90 days.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDomainTopUrlVisit

The operation that you want to perform. Set the value to DescribeDomainTopUrlVisit.

DomainName String No example.com

The accelerated domain name. You can specify only one domain name in each call. If you do not set this parameter, data of all accelerated domain names that belong to your Alibaba Cloud account is queried and merged.

StartTime String No 2015-12-03

The start of the time range to query.

  • Specify the time in the YYYY-MM-DD format in UTC+8.
  • If you do not set this parameter, data within the last 24 hours is queried.
SortBy String No pv

The order by which the data is sorted. Valid values:

  • traf: traffic.
  • pv: the number of page views (PVs). This is the default value.

Response parameters

Parameter Type Example Description
AllUrlList Array of UrlList

A list of frequently requested URLs.

UrlList
Flow String 460486880

The amount of network traffic consumed by visits to the URL, in bytes.

FlowProportion Float 0.35

The proportion of network traffic consumed to access the URL.

UrlDetail String http://example.com/nn_live/nn_x64/a0.m3u8

The complete URL.

VisitData String 161673

The number of visits to the URL.

VisitProportion Float 0.35

The proportion of visits to the URL.

DomainName String example.com

The accelerated domain name.

RequestId String 64D28B53-5902-409B-94F6-FD46680144FE

The ID of the request.

StartTime String 2015-12-03

The beginning of the time range that was queried.

Url200List Array of UrlList

A list of URLs for which 2xx status codes were returned.

UrlList
Flow String 460486880

The amount of network traffic consumed by visits to the URL, in bytes.

FlowProportion Float 0.35

The proportion of network traffic consumed to access the URL.

UrlDetail String http://example.com/nn_live/nn_x64/aWQ9SE5KU0bGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8

The complete URL.

VisitData String 161673

The number of visits to the URL.

VisitProportion Float 0.35

The proportion of the visits to the URL.

Url300List Array of UrlList

A list of URLs for which 3xx status codes were returned.

UrlList
Flow String 460486880

The network traffic consumed by visits to the URL, in bytes.

FlowProportion Float 0.35

The proportion of network traffic consumed to access the URL.

UrlDetail String http://example.com/nn_live/nn_x64/a0.m3u8

The complete URL.

VisitData String 161673

The number of visits to the URL.

VisitProportion Float 0.35

The proportion of visits to the URL.

Url400List Array of UrlList

A list of URLs for which 4xx status codes were returned.

UrlList
Flow String 460486880

The amount of network traffic consumed by visits to the URL, in bytes.

FlowProportion Float 0.35

The proportion of network traffic consumed to access the URL.

UrlDetail String http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUhbGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8

The complete URL.

VisitData String 1884

The number of visits to the URL.

VisitProportion Float 0.35

The proportion of visits to the URL.

Url500List Array of UrlList

A list of URLs for which 5xx status codes were returned.

UrlList
Flow String 460486880

The amount of network traffic consumed by visits to the URL, in bytes.

FlowProportion Float 0.35

The proportion of network traffic consumed to access the URL.

UrlDetail String http://example.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8

The complete URL.

VisitData String 161673

The number of visits to the URL.

VisitProportion Float 0.35

The proportion of visits.

Examples

Sample requests

http://cdn.aliyuncs.com/?Action=DescribeDomainTopUrlVisit
&DomainName=example.com
&StartTime=2015-12-03
&<Common request parameters>

Sample success responses

XML format

<DescribeDomainTopUrlVisitResponse>
      <AllUrlList>
            <UrlList>
                  <VisitData>161673</VisitData>
                  <UrlDetail>http://example.com/nn_live/nn_x64/a0.m3u8</UrlDetail>
                  <VisitProportion>0.35</VisitProportion>
                  <Flow>460486880</Flow>
                  <FlowProportion>0.35</FlowProportion>
            </UrlList>
            <UrlList>
                  <VisitData>37</VisitData>
                  <UrlDetail>http://example.com/nn_live/nn_x64/ZXg9MQ,,/HNJSMPP360.ts</UrlDetail>
                  <VisitProportion>0.35</VisitProportion>
                  <Flow>460486880</Flow>
                  <FlowProportion>0.35</FlowProportion>
            </UrlList>
      </AllUrlList>
      <Url300List>
            <UrlList>
                  <VisitData>161673</VisitData>
                  <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8</UrlDetail>
                  <VisitProportion>0.35</VisitProportion>
                  <Flow>460486880</Flow>
                  <FlowProportion>0.35</FlowProportion>
            </UrlList>
            <UrlList>
                  <VisitData>3</VisitData>
                  <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUDZXg9MQ,,/HNJSMPP360.ts</UrlDetail>
                  <VisitProportion>0.35</VisitProportion>
                  <Flow>460486880</Flow>
                  <FlowProportion>0.35</FlowProportion>
            </UrlList>
      </Url300List>
      <Url400List>
            <UrlList>
                  <VisitData>1884</VisitData>
                  <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUhbGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8</UrlDetail>
                  <VisitProportion>0.35</VisitProportion>
                  <Flow>460486880</Flow>
                  <FlowProportion>0.35</FlowProportion>
            </UrlList>
            <UrlList>
                  <VisitData>1</VisitData>
                  <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SEEwODgmpbmRleZPTE,/HNJSMPP360.ts</UrlDetail>
                  <VisitProportion>0.35</VisitProportion>
                  <Flow>460486880</Flow>
                  <FlowProportion>0.35</FlowProportion>
            </UrlList>
      </Url400List>
      <RequestId>64D28B53-5902-409B-94F6-FD46680144FE</RequestId>
      <DomainName>example.com</DomainName>
      <Url200List>
            <UrlList>
                  <VisitData>161673</VisitData>
                  <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU0bGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8</UrlDetail>
                  <VisitProportion>0.35</VisitProportion>
                  <Flow>460486880</Flow>
                  <FlowProportion>0.35</FlowProportion>
            </UrlList>
            <UrlList>
                  <VisitData>3</VisitData>
                  <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUDMlPTIwMTxMDk5ZXg9MQ,,/HNJSMPP360.ts</UrlDetail>
                  <VisitProportion>0.35</VisitProportion>
                  <Flow>460486880</Flow>
                  <FlowProportion>0.35</FlowProportion>
            </UrlList>
      </Url200List>
      <StartTime>2018-10-03T16:00:00Z</StartTime>
      <Url500List>
            <UrlList>
                  <VisitData>161673</VisitData>
                  <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8</UrlDetail>
                  <VisitProportion>0.35</VisitProportion>
                  <Flow>460486880</Flow>
                  <FlowProportion>0.35</FlowProportion>
            </UrlList>
            <UrlList>
                  <VisitData>3</VisitData>
                  <UrlDetail>http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUDZXg9MQ,,/HNJSMPP360.ts</UrlDetail>
                  <VisitProportion>0.35</VisitProportion>
                  <Flow>460486880</Flow>
                  <FlowProportion>0.35</FlowProportion>
            </UrlList>
      </Url500List>
</DescribeDomainTopUrlVisitResponse>

JSON format

{
    "AllUrlList": {
        "UrlList": [
            {
                "VisitData": "161673",
                "UrlDetail": "http://example.com/nn_live/nn_x64/a0.m3u8",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            },
            {
                "VisitData": "37",
                "UrlDetail": "http://example.com/nn_live/nn_x64/ZXg9MQ,,/HNJSMPP360.ts",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            }                      
        ]
    },
    "Url300List": {
        "UrlList": [
            {
                "VisitData": "161673",
                "UrlDetail": "http://example.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            },
            {
                "VisitData": "3",
                "UrlDetail": "http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUDZXg9MQ,,/HNJSMPP360.ts",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            }
        ]
    },
    "Url400List": {
        "UrlList": [
            {
                "VisitData": "1884",
                "UrlDetail": "http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUhbGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            },
            {
                "VisitData": "1",
                "UrlDetail": "http://example.com/nn_live/nn_x64/aWQ9SEEwODgmpbmRleZPTE,/HNJSMPP360.ts",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            }           
        ]
    },
    "RequestId": "64D28B53-5902-409B-94F6-FD46680144FE",
    "DomainName": "example.com",
    "Url200List": {
        "UrlList": [
            {
                "VisitData": "161673",
                "UrlDetail": "http://example.com/nn_live/nn_x64/aWQ9SE5KU0bGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            },
            {
                "VisitData": "3",
                "UrlDetail": "http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUDMlPTIwMTxMDk5ZXg9MQ,,/HNJSMPP360.ts",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            }
        ]
    },
    "StartTime": "2018-10-03T16:00:00Z",
    "Url500List": {
        "UrlList": [
            {
                "VisitData": "161673",
                "UrlDetail": "http://example.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            },           
            {
                "VisitData": "3",
                "UrlDetail": "http://example.com/nn_live/nn_x64/aWQ9SE5KU01QUDZXg9MQ,,/HNJSMPP360.ts",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            }
        ]
    }
}

Error codes

HttpCode Error code Error message Description
400 MissingParameter The specified value of parameter "StartTime" is not valid. The error message returned because the specified start time is invalid.
400 InvalidStartTime.Malformed Specified StartTime is malformed. The error message returned because the format of the specified start time is invalid. For more information about the time format, see the Request parameters section.
400 InvalidDomainName.ValueNotSupported The specified value of parameter DomainName only support one or empty value. The error message returned because you can specify at most one accelerated domain name.
400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported. The error message returned because the specified start time is invalid. Rectify the start time and try again.

For a list of error codes, visit the API Error Center.