All Products
Search
Document Center

Anti-DDoS:DescribeDomainQpsWithCache

Last Updated:Apr 16, 2024

Queries the QPS and the cache hit ratio of the specified domain name.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeDomainQpsWithCacheRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

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.

default
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.aliyun.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.
1582992000
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.
1583683200

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

ParameterTypeDescriptionExample
object
StartTimelong

The start time. The value is a UNIX timestamp. Unit: seconds.

1582992000
RequestIdstring

The ID of the request.

0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc
Intervalinteger

The intervals between every two adjacent records. Unit: seconds.

20384
Blocksarray

An array that consists of the attack QPS.

string

The attack QPS.

[20,30,20]
CcBlockQpsarray

An array consisting of the QPS that is blocked by the Frequency Control policy.

string

The QPS that is blocked by the Frequency Control policy.

[1,0,0]
PreciseJsQpsarray

An array consisting of the QPS for which the Accurate Access Control policy triggers the JavaScript challenge.

string

The QPS for which the Accurate Access Control policy triggers the JavaScript challenge.

[1,0,0]
CcJsQpsarray

An array consisting of the QPS for which the Frequency Control policy triggers Completely Automated Public Turing test to tell Computers and Humans Apart (CAPTCHA).

string

The QPS for which the Frequency Control policy triggers CAPTCHA.

[1,0,0]
RegionBlocksarray

An array consisting of the QPS that is blocked by the Location Blacklist policy.

string

The QPS that is blocked by the Location Blacklist policy.

[1,0,0]
PreciseBlocksarray

An array consisting of the QPS that is blocked by the Accurate Access Control policy.

string

The QPS blocked by the Accurate Access Control policy.

[1,0,0]
CacheHitsarray

An array consisting of cache hit ratios.

string

The cache hit ratio. The values are decimals. For example, 0.5 indicates that the cache hit ratio is 50%.

[0.3,0.4,0.5]
Totalsarray

An array consisting of the total QPS.

string

The total QPS.

[100,400,200]
IpBlockQpsarray

An array consisting of the QPS that is blocked by the blacklist for domain names.

string

The QPS blocked by the blacklist for domain names.

[1,0,0]

Examples

Sample success responses

JSONformat

{
  "StartTime": 1582992000,
  "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc",
  "Interval": 20384,
  "Blocks": [
    "[20,30,20]"
  ],
  "CcBlockQps": [
    "[1,0,0]"
  ],
  "PreciseJsQps": [
    "[1,0,0]"
  ],
  "CcJsQps": [
    "[1,0,0]"
  ],
  "RegionBlocks": [
    "[1,0,0]"
  ],
  "PreciseBlocks": [
    "[1,0,0]"
  ],
  "CacheHits": [
    "[0.3,0.4,0.5]"
  ],
  "Totals": [
    "[100,400,200]"
  ],
  "IpBlockQps": [
    "[1,0,0]"
  ]
}

Error codes

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