DescribeDomainTopUserAgent - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the information about top user agents of a website.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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.	www.example.com
StartTime	long	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.	1609430400
EndTime	long	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.	1708352700
Limit	long	Yes	The maximum number of entries to return.	20

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	CF33B4C3-196E-4015-AADD-5CAD00057B80
DomainTopUa	array<object>	The information about the user agents.
DomainTopUa	object	The information about the user agent.
UserAgent	string	The Base64-encoded user agent.	TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvOTYuMC40NjY0LjExMCACYWZhcmkvNTM3LjM2
Pv	long	The page views.	22121
Domain	string	The domain name of the website.	www.example.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "CF33B4C3-196E-4015-AADD-5CAD00057B80",
  "DomainTopUa": [
    {
      "UserAgent": "TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvOTYuMC40NjY0LjExMCACYWZhcmkvNTM3LjM2",
      "Pv": 22121,
      "Domain": "www.example.com\n"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.