All Products
Search
Document Center

Anti-DDoS:DescribeDomainTopUserAgent

Last Updated:Nov 13, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-ddoscoo:DescribeDomainTopUserAgentlist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringYes

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
DomainstringNo

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
StartTimelongYes

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
EndTimelongYes

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
LimitlongYes

The maximum number of entries to return.

20

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

CF33B4C3-196E-4015-AADD-5CAD00057B80
DomainTopUaarray<object>

The information about the user agents.

DomainTopUaobject

The information about the user agent.

UserAgentstring

The Base64-encoded user agent.

TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvOTYuMC40NjY0LjExMCACYWZhcmkvNTM3LjM2
Pvlong

The page views.

22121
Domainstring

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.