DescribeDomainViewTopUrl

Updated at:
Copy as MD

This operation queries the top URLs by request count for a website service within a specified time range.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

ResourceGroupId

string

No

The ID of the resource group to which the Anti-DDoS Pro instance belongs in Resource Management. If you do not specify this parameter, the instance belongs to the default resource group.

default

StartTime

integer

Yes

The beginning of the time range to query. This is a UNIX timestamp. Unit: seconds.

Note

The timestamp must be at the beginning of a minute.

1582992000

EndTime

integer

Yes

The end of the time range to query. This is a UNIX timestamp. Unit: seconds.

Note

The timestamp must be at the beginning of a minute.

1583683200

Domain

string

No

The domain name of the website.

Note

You must have configured forwarding rules for the domain name. You can call the DescribeDomains operation to query all domain names.

www.aliyun.com

Top

integer

Yes

The number of top URLs to return. Valid values: 1 to 100.

5

Inerval

integer

No

The data aggregation interval. Unit: seconds. The supported value of this parameter varies based on the time range. The time range is determined by the StartTime and EndTime parameters. We recommend that you specify the following values:

  • If the time range is no more than 1 hour, we recommend that you specify this parameter to a value of at least 60.

  • If the time range is from 1 to 6 hours, we recommend that you specify this parameter to a value of at least 600.

  • If the time range is from 6 to 24 hours, we recommend that you specify this parameter to a value of at least 1,800.

  • If the time range is from 24 hours to 7 days, we recommend that you specify this parameter to a value of at least 3,600.

  • If the time range is from 7 to 15 days, we recommend that you specify this parameter to a value of at least 14,400.

  • If the time range is more than 15 days, we recommend that you specify this parameter to a value of at least 43,200.

60

Response elements

Element

Type

Description

Example

object

The response.

RequestId

string

The ID of the request.

C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E

UrlList

array<object>

An array of the top URLs that are ranked by the number of requests.

object

Url

string

The URL that is Base64-encoded.

Lw==

Domain

string

The domain name of the website.

www.aliyun.com

Count

integer

The number of requests.

3390671

Examples

Success response

JSON format

{
  "RequestId": "C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E",
  "UrlList": [
    {
      "Url": "Lw==",
      "Domain": "www.aliyun.com",
      "Count": 3390671
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.