Query Cleaning Service - DescribeCleanService

Overview

Query Cleaning Service

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeCleanService`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
ResourceId	string	Resource 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
CleanRegion	string	Clean the machine room, no transmission represents all. Query all.	No
Offset	int	Data offset, default is 0. Used for pagination display.	No
Limit	int	Returns the maximum number of cleaned entries, default is 10. Used for pagination display.	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
TotalCount	int	Total number of eligible entries	Yes
CleanServiceList	array[CleanServiceList]	Cleaning Service List	Yes

Data Model

CleanServiceList

Field Name	Type	Description Information	Required
ResourceId	string	Resource ID	Yes
CreateTime	string	Creation Time (Timestamp)	Yes
ExpiredTime	string	Expiration Time (Timestamp)	Yes
CleanRegion	string	Region	Yes
MaxCleanCapacity	int	Traffic cleaning upper limit protection traffic (unit G), 5, 10, 15, 20, 25	Yes
DefenceStatus	string	Status, the current status of the cleaning service Current status (Cleaning in progress: Cleaning Expired: Expired)	Yes
StatusRemarks	string	Supplementary explanation of status (Normal: Normal, Exceed: Exceed)	Yes
ChargeType	string	Billing Method (Month: Monthly, Year: Yearly)	Yes
AutoRenewal	int	Auto-renewal 1: On 0: Off	Yes
DefenseIP	int	Most Recent Attacked IP	Yes
DefenseTime	string	Recent Attack Time, Timestamp	Yes
DefensePeak	float	Recent Peak Attack Traffic	Yes
BlockIpNum	int	The number of IPs being blocked	Yes
CleanIpNum	int	The number of IPs being cleaned	Yes
BuyMaxCleanCapacityLimit	int	Maximum cleaning threshold allowed for purchase	Yes
PublicTest	int	Public Beta Tag	Yes
CustomCleanPolicy	int	Supports custom cleaning threshold configuration	Yes
Tips	string	Prompt information, matching with the front-end page display	Yes

Example

Request Example

https://api.surfercloud.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
}

Index GetCleanServicePrice