All Products
Search

This Product

    Anti-DDoS:DescribeInstanceStatistics

    Document Center

    Anti-DDoS:DescribeInstanceStatistics

    Last Updated:Apr 16, 2024

    Queries the statistics on one or more Anti-DDoS Proxy 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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    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
    InstanceStatisticsobject []

    The statistics on the instances.

    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 Premium 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.