DescribeDomainTopReferer - Anti-DDoS - Alibaba Cloud Documentation Center

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

yundun-ddoscoo:DescribeDomainTopReferer

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The region in which your service is deployed. Valid values: cn: a region in the Chinese mainland. cn-hongkong: a region outside the Chinese mainland.	cn
Domain	string	No	The domain name of the website. Note A forwarding rule must be configured for the domain name. You can call the DescribeDomains operation to query all domain names.	example.aliyundoc.com
StartTime	integer	Yes	The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1701991920
EndTime	integer	Yes	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1721561100
Limit	integer	Yes	The maximum number of entries to return.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CF33B4C3-196E-4015-AADD-5CAD00057B80
DomainTopReferer	array<object>	The information about top referers.
	object	The information about the referer.
Referer	string	The Base64-encoded referer.	aHR0cHM6Ly9zZXJ2aWNld2VjaGF0LmNvbS93eGY3ZDc5YWY0YzU4ZDH3NTEvNC9wYWdlLWZyYW1lLmh0bWw=
Pv	integer	The page views.	257031
Domain	string	The domain name of the website.	example.aliyundoc.com

Examples

Success response

JSON format

{
  "RequestId": "CF33B4C3-196E-4015-AADD-5CAD00057B80",
  "DomainTopReferer": [
    {
      "Referer": "aHR0cHM6Ly9zZXJ2aWNld2VjaGF0LmNvbS93eGY3ZDc5YWY0YzU4ZDH3NTEvNC9wYWdlLWZyYW1lLmh0bWw=",
      "Pv": 257031,
      "Domain": "example.aliyundoc.com\n"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.