Get the price of the cleaning package - GetCleanServicePrice
Overview
Get the price of the cleaning package
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetCleanServicePrice . | 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 |
---|---|---|---|
ChargeType | string | Billing Type (Month: Monthly, Year: Yearly) | Yes |
CleanRegion | string | Maintain and update the available region list through GetCleanServiceRegion to cope with the expanding data centers. As of 2019-01-24, the currently available list can be seen in the enumeration: | Yes |
Quantity | int | Protection Duration (0 represents end of the purchase month, end of the year) | Yes |
MaxCleanCapacity | int | Traffic cleaning upper limit protection traffic (unit G), default 5 | 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 |
Price | int | Cleaning Package Price | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=GetCleanServicePrice
&ChargeType=Month
&CleanRegion=TpaukPxG
&MaxCleanCapacity=2
&Quantity=3
Response Example
{
"Action": "GetCleanServicePriceResponse",
"Price": 8,
"RetCode": 0
}