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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstanceStatistics

The operation that you want to perform. Set the value to DescribeInstanceStatistics.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: Chinese mainland, which indicates Anti-DDoS Pro instances
  • ap-southeast-1: outside the Chinese mainland, which indicates Anti-DDoS Premium instances
InstanceIds.N String Yes ddoscoo-cn-mp91j1ao****

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.

Response parameters

Parameter Type Example Description
RequestId String 642319A9-D1F2-4459-A447-E57CFC599FDE

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

InstanceStatistics Array of InstanceStatistic

The statistics on the instances.

DomainUsage Integer 1

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

DefenseCountUsage Integer 1

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

Note This parameter is returned only if Anti-DDoS Premium instances are queried.
InstanceId String ddoscoo-cn-mp91j1ao****

The ID of the instance.

SiteUsage Integer 1

The number of websites that are protected by the instance.

PortUsage Integer 2

The number of ports that are protected by the instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeInstanceStatistics
&InstanceIds=["ddoscoo-cn-mp91j1ao****"]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceStatisticsResponse>
    <RequestId>642319A9-D1F2-4459-A447-E57CFC599FDE</RequestId>
    <InstanceStatistics>
        <DomainUsage>1</DomainUsage>
        <DefenseCountUsage>1</DefenseCountUsage>
        <InstanceId>ddoscoo-cn-mp91j1ao****</InstanceId>
        <SiteUsage>1</SiteUsage>
        <PortUsage>2</PortUsage>
    </InstanceStatistics>
</DescribeInstanceStatisticsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 API Error Center.