Docs
api
DDoS Attack Protection(UDDos)
DescribeCleanService

Query Cleaning Service - DescribeCleanService

Overview

Query Cleaning Service

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeCleanService.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ResourceIdstringResource ID, if empty, it means to query all cleaning resources under the user; when it is not empty, it means to query the cleaning service of the specified resource ID; default is empty.No
CleanRegionstringClean the machine room, no transmission represents all. Query all.No
OffsetintData offset, default is 0. Used for pagination display.No
LimitintReturns the maximum number of cleaned entries, default is 10. Used for pagination display.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
TotalCountintTotal number of eligible entriesYes
CleanServiceListarray[CleanServiceList]Cleaning Service ListYes

Data Model

CleanServiceList

Field NameTypeDescription InformationRequired
ResourceIdstringResource IDYes
CreateTimestringCreation Time (Timestamp)Yes
ExpiredTimestringExpiration Time (Timestamp)Yes
CleanRegionstringRegionYes
MaxCleanCapacityintTraffic cleaning upper limit protection traffic (unit G), 5, 10, 15, 20, 25Yes
DefenceStatusstringStatus, the current status of the cleaning service
Current status (Cleaning in progress: Cleaning Expired: Expired)
Yes
StatusRemarksstringSupplementary explanation of status (Normal: Normal, Exceed: Exceed)Yes
ChargeTypestringBilling Method (Month: Monthly, Year: Yearly)Yes
AutoRenewalintAuto-renewal
1: On
0: Off
Yes
DefenseIPintMost Recent Attacked IPYes
DefenseTimestringRecent Attack Time, TimestampYes
DefensePeakfloatRecent Peak Attack TrafficYes
BlockIpNumintThe number of IPs being blockedYes
CleanIpNumintThe number of IPs being cleanedYes
BuyMaxCleanCapacityLimitintMaximum cleaning threshold allowed for purchaseYes
PublicTestintPublic Beta TagYes
CustomCleanPolicyintSupports custom cleaning threshold configurationYes
TipsstringPrompt information, matching with the front-end page displayYes

Example

Request Example

https://api.dezai.com/?Action=DescribeCleanService
&Offset=9
&Limit=7
&CleanRegion=RYaHCbJg

Response Example

{
  "Action": "DescribeCleanServiceResponse",
  "CleanServiceList": [
    {
      "AutoRenewal": 1,
      "BlockIpNum": 1,
      "BuyMaxCleanCapacityLimit": 10,
      "ChargeType": "Month",
      "CleanIpNum": 1,
      "CleanRegion": "上海",
      "CreateTime": 1526438569,
      "DefenceStatus": "Started",
      "DefenseFlow": 80.344,
      "DefenseIP": "192.168.254.10",
      "DefenseTime": 1523334896,
      "ExpiredTime": 1529116968,
      "MaxCleanCapacity": 15,
      "ResourceId": "usecure_UCLEAN-dch4di"
    },
    {
      "AutoRenewal": 1,
      "BlockIpNum": 1,
      "BuyMaxCleanCapacityLimit": 10,
      "ChargeType": "Month",
      "CleanIpNum": 1,
      "CleanRegion": "北京",
      "CreateTime": 1526437820,
      "DefenceStatus": "Started",
      "DefenseFlow": 80.344,
      "DefenseIP": "192.168.254.10",
      "DefenseTime": 1523334896,
      "ExpiredTime": 1529116220,
      "MaxCleanCapacity": 5,
      "ResourceId": "usecure_UCLEAN-sei2sx"
    }
  ],
  "RetCode": 0,
  "TotalCount": 2
}