DescribeDcdnDomainTopUrlVisit - Edge Security Acceleration

Call DescribeDcdnDomainTopUrlVisit to retrieve the top URLs for an accelerated domain name on a specific day.

Operation description

Note

You can query data generated in the last 7 days.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dcdn:DescribeDcdnDomainTopUrlVisit

get

*domain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can specify only one domain name.	example.com
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. To query data for a specific day, set this parameter to YYYY-MM-DDT16:00:00Z. Note If you do not set this parameter, data from the last 24 hours is queried.	2018-10-03T16:00:00Z
SortBy	string	No	The sorting method. Valid values: traf: by traffic. pv: by the number of visits. Default value: pv.	pv

Response elements

Parameter	Type	Description	Example
	object
StartTime	string	The query date.	2018-10-03T16:00:00Z
RequestId	string	The request ID.	64D28B53-5902-409B-94F6-FD46680144FE
DomainName	string	The accelerated domain name.	example.com
AllUrlList	object
UrlList	array<object>	The list of all popular URLs.
	object
Flow	string	The traffic. Unit: byte.	460486880
UrlDetail	string	The full URL.	http://example.com/nn_live/nn_x64/a0.m3u8
FlowProportion	number	The traffic proportion.	0.35
VisitData	string	The number of visits.	161673
VisitProportion	number	The visit proportion.	0.35
Url200List	object
UrlList	array<object>	The list of URLs for which a 2xx status code was returned.
	object
Flow	string	The traffic. Unit: byte.	460486880
UrlDetail	string	The full URL.	http://example.com/nn_live/nn_x64/a0.m3u8
FlowProportion	number	The traffic proportion.	0.35
VisitData	string	The number of visits.	161673
VisitProportion	number	The visit proportion.	0.35
Url300List	object
UrlList	array<object>	The list of URLs for which a 3xx status code was returned.
	object
Flow	string	The traffic. Unit: byte.	460486880
UrlDetail	string	The full URL.	http://example.com/nn_live/nn_x64/a0.m3u8
FlowProportion	number	The traffic proportion.	0.35
VisitData	string	The number of visits.	161673
VisitProportion	number	The visit proportion.	0.35
Url400List	object
UrlList	array<object>	The list of URLs for which a 4xx status code was returned.
	object
Flow	string	The traffic. Unit: byte.	460486880
UrlDetail	string	The full URL.	http://example.com/nn_live/nn_x64/a0.m3u8
FlowProportion	number	The traffic proportion.	0.35
VisitData	string	The number of visits.	161673
VisitProportion	number	The visit proportion.	0.35
Url500List	object
UrlList	array<object>	The list of URLs for which a 5xx status code was returned.
	object
Flow	string	The traffic. Unit: byte.	460486880
UrlDetail	string	The full URL.	http://example.com/nn_live/nn_x64/a0.m3u8
FlowProportion	number	The traffic proportion.	0.35
VisitData	string	The number of visits.	161673
VisitProportion	number	The visit proportion.	0.35

Examples

Success response

JSON format

{
  "StartTime": "2018-10-03T16:00:00Z",
  "RequestId": "64D28B53-5902-409B-94F6-FD46680144FE",
  "DomainName": "example.com",
  "AllUrlList": {
    "UrlList": [
      {
        "Flow": "460486880",
        "UrlDetail": "http://example.com/nn_live/nn_x64/a0.m3u8",
        "FlowProportion": 0.35,
        "VisitData": "161673",
        "VisitProportion": 0.35
      }
    ]
  },
  "Url200List": {
    "UrlList": [
      {
        "Flow": "460486880",
        "UrlDetail": "http://example.com/nn_live/nn_x64/a0.m3u8",
        "FlowProportion": 0.35,
        "VisitData": "161673",
        "VisitProportion": 0.35
      }
    ]
  },
  "Url300List": {
    "UrlList": [
      {
        "Flow": "460486880",
        "UrlDetail": "http://example.com/nn_live/nn_x64/a0.m3u8",
        "FlowProportion": 0.35,
        "VisitData": "161673",
        "VisitProportion": 0.35
      }
    ]
  },
  "Url400List": {
    "UrlList": [
      {
        "Flow": "460486880",
        "UrlDetail": "http://example.com/nn_live/nn_x64/a0.m3u8",
        "FlowProportion": 0.35,
        "VisitData": "161673",
        "VisitProportion": 0.35
      }
    ]
  },
  "Url500List": {
    "UrlList": [
      {
        "Flow": "460486880",
        "UrlDetail": "http://example.com/nn_live/nn_x64/a0.m3u8",
        "FlowProportion": 0.35,
        "VisitData": "161673",
        "VisitProportion": 0.35
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.	The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.