All Products
Search
Document Center

Anti-DDoS:DescribeInstanceStatistics

Last Updated:Oct 23, 2024

Queries the statistics on one or more Anti-DDoS Proxy instances, such as the numbers of protected domain names and ports.

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

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdsarrayYes

The ID of the instance that you want to query.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.
stringYes

The ID of instance N to query. The maximum value of N is 200. You can specify up to 200 instances. Separate the IDs of multiple instances with commas (,).

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.
ddoscoo-cn-mp91j1ao****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

642319A9-D1F2-4459-A447-E57CFC599FDE
InstanceStatisticsarray<object>

The statistics on the instance.

InstanceStatisticobject
DomainUsageinteger

The number of domain names that are protected by the instance.

1
DefenseCountUsageinteger

The number of advanced mitigation sessions that are used in this month.

Note This parameter is returned only if Anti-DDoS Proxy (Outside Chinese Mainland) instances are queried.
1
InstanceIdstring

The ID of the instance.

ddoscoo-cn-mp91j1ao****
SiteUsageinteger

The number of websites that are protected by the instance.

1
PortUsageinteger

The number of ports that are protected by the instance.

2

Examples

Sample success responses

JSONformat

{
  "RequestId": "642319A9-D1F2-4459-A447-E57CFC599FDE",
  "InstanceStatistics": [
    {
      "DomainUsage": 1,
      "DefenseCountUsage": 1,
      "InstanceId": "ddoscoo-cn-mp91j1ao****",
      "SiteUsage": 1,
      "PortUsage": 2
    }
  ]
}

Error codes

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