DescribeDomainTopUrlVisit

Last Updated: Apr 02, 2018

Description

  • Obtain the popular URL list for a CDN domain name on a specific day.

  • When StartTime is not specified, the interface reads data from the past day be default.

    • The system supports query of only one domain name or all domain names belonging to the current user.

    • Data from the past 90 days can be obtained at most.

Request parameters

Parameters Type Required Example values Description
Action String Yes DescribeDomainTopUrlVisit

The name of this interface. Value: DescribeDomainTopUrlVisit

DomainName String No test.test.com

Only one domain name is supported. If the parameter is left blank, the return results contain the combined data of all CDN domains by default.

SortBy String No pv

Sorting manner.

  • Supports traf and pv.
  • Default value: pv

StartTime String No 2015-12-03

Start time of data query, and adopts Beijing time.

  • Format: YYYY-MM-DD.
  • If this parameter is unspecified, data from the past 24 hours is read by default.

Return parameters

Parameters Type Example values Description
RequestId String 64D28B53-5902-409B-94F6-FD46680144FE

Request ID

DomainName String test.com

CDN domain name

StartTime String 2015-12-03

Specified date of query.

AllUrlList

List of all popular URLs.

  └UrlDetail String http://test.com/nn_live/nn_x64/a0.m3u8

Complete URL.

  └VisitData String 161673

Times of access.

  └VisitProportion Float 0.35

Access proportion.

  └Flow String 460486880

Traffic.
Unit: byte

  └FlowProportion Float 0.35

Traffic proportion.

Url200List

Returned URL list in 2xx format.

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

Complete URL.

  └VisitData String 161673

Times of access.

  └VisitProportion Float 0.35

Access proportion.

  └Flow String 460486880

Traffic.
Unit: byte

  └FlowProportion Float 0.35

Traffic proportion.

Url300List

Returned URL list in 3xx format.

  └UrlDetail String http://test.com/nn_live/nn_x64/a0.m3u8

Complete URL.

  └VisitData String 161673

Times of access.

  └VisitProportion Float 0.35

Access proportion.

  └Flow String 460486880

Traffic.
Unit: byte

  └FlowProportion Float 0.35

Traffic proportion.

Url400List

Returned URL list in 4xx format.

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

Complete URL.

  └VisitData String 1884

Times of access.

  └VisitProportion Float 0.35

Access proportion.

  └Flow String 460486880

Traffic.
Unit: byte

  └FlowProportion Float 0.35

Traffic proportion.

Url500List

Returned URL list in 5xx format.

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

Complete URL.

  └VisitData String 161673

Times of access.

  └VisitProportion Float 0.35

Access proportion.

  └Flow String 460486880

Traffic.
Unit: byte

  └FlowProportion Float 0.35

Traffic proportion.

Example

Request example

  1. http://cdn.aliyuncs.com?Action=DescribeDomainTopUrlVisit&DomainName=test.com
  2. &StartTime=2015-12-03
  3. &<public request parameter>

Normal return example

JSON format

  1. {
  2. "AllUrlList":{
  3. "UrlList":[
  4. {
  5. "Flow":"460486880",
  6. "FlowProportion":0.35,
  7. "UrlDetail":"http://test.com/nn_live/nn_x64/a0.m3u8",
  8. "VisitData":"161673",
  9. "VisitProportion":0.35
  10. },
  11. {
  12. "Flow":"460486880",
  13. "FlowProportion":0.35,
  14. "UrlDetail":"http://test.com/nn_live/nn_x64/ZXg9MQ,,/HNJSMPP360.ts",
  15. "VisitData":"37",
  16. "VisitProportion":0.35
  17. }
  18. ]
  19. },
  20. "DomainName":"test.com",
  21. "RequestId":"64D28B53-5902-409B-94F6-FD46680144FE",
  22. "StartTime":"2015-12-03",
  23. "Url200List":{
  24. "UrlList":[
  25. {
  26. "Flow":"460486880",
  27. "FlowProportion":0.35,
  28. "UrlDetail":"http://test.com/nn_live/nn_x64/aWQ9SE5KU0bGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8",
  29. "VisitData":"161673",
  30. "VisitProportion":0.35
  31. },
  32. {
  33. "Flow":"460486880",
  34. "FlowProportion":0.35,
  35. "UrlDetail":"http://test.com/nn_live/nn_x64/aWQ9SE5KU01QUDMlPTIwMTxMDk5ZXg9MQ,,/HNJSMPP360.ts",
  36. "VisitData":"3",
  37. "VisitProportion":0.35
  38. }
  39. ]
  40. },
  41. "Url300List":{
  42. "TopUrlVisitModel":[]
  43. },
  44. "Url400List":{
  45. "UrlList":[
  46. {
  47. "Flow":"460486880",
  48. "FlowProportion":0.35,
  49. "UrlDetail":"http://test.com/nn_live/nn_x64/aWQ9SE5KU01QUhbGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8",
  50. "VisitData":"1884",
  51. "VisitProportion":0.35
  52. },
  53. {
  54. "Flow":"460486880",
  55. "FlowProportion":0.35,
  56. "UrlDetail":"http://test.com/nn_live/nn_x64/aWQ9SEEwODgmpbmRleZPTE,/HNJSMPP360.ts",
  57. "VisitData":"1",
  58. "VisitProportion":0.35
  59. }
  60. ]
  61. },
  62. "Url500List":{
  63. "UrlList":[
  64. {
  65. "Flow":"460486880",
  66. "FlowProportion":0.35,
  67. "UrlDetail":"http://test.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8",
  68. "VisitData":"161673",
  69. "VisitProportion":0.35
  70. },
  71. {
  72. "Flow":"460486880",
  73. "FlowProportion":0.35,
  74. "UrlDetail":"http://test.com/nn_live/nn_x64/aWQ9SE5KU01QUDZXg9MQ,,/HNJSMPP360.ts",
  75. "VisitData":"3",
  76. "VisitProportion":0.35
  77. }
  78. ]
  79. }
  80. }

Exception return example

JSON format

  1. {
  2. "Code":"InternalError",
  3. "HostId":"cdn.aliyuncs.com",
  4. "Message":"The request processing has failed due to some unknown error.",
  5. "RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
  6. }

Error code

For more information, see Error code of this product.

Thank you! We've received your feedback.