DescribeDomainOverview - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the attack overview of a website, such as the peak HTTP and HTTPS traffic.

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

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribeDomainOverview	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group. For more information about resource groups, see Create a resource group.	rg-acfm2pz25js****
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.	1619798400
EndTime	long	No	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you leave this parameter unspecified, the current system time is used as the end time. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1623427200
Domain	string	No	The domain name of the website that you want to query. If you leave this parameter unspecified, the statistics on all domain names are queried. Note The domain name must be added to Anti-DDoS Pro or Anti-DDoS Premium. You can call the DescribeDomains operation to query all the domain names that are added to Anti-DDoS Pro or Anti-DDoS Premium.	example.aliyundoc.com

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E
MaxHttp	long	The peak queries per second (QPS) during HTTP traffic scrubbing. Unit: QPS.	41652
MaxHttps	long	The peak QPS during HTTPS traffic scrubbing. Unit: QPS.	0

Examples

Sample success responses

JSONformat

{
  "RequestId": "C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E",
  "MaxHttp": 41652,
  "MaxHttps": 0
}

Error codes

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