CC Defense Rule List - DescribeAntiCCRules

Overview

CC Defense Rule List

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeAntiCCRules`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	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
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
Domain	string	To query the domain of the protection rules	Yes
FullDomain	string	Domain	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
Res	AntiCcRes	CC Rules, refer to AntiCcRes	No

Data Model

AntiCcRes

Field Name	Type	Description Information	Required
State	string	CC Protection Status of the Specified Domain	Yes
Mode	string	CC Protection Mode for Specified Domain	Yes
Max	int	Maximum Capacity of CC Rules	Yes
Rules	array[AntiCcRule]	CC Rule List, refer to AntiCcRule	Yes

AntiCcRule

Field Name	Type	Description Information	Required
Id	int	Rule ID	Yes
Uri	string	URI	Yes
Mode	string	Mode	Yes
Duration	int	Duration Statistics. Unit: Seconds.	Yes
Reqs	int	Request Times	Yes
Action	string	Execute Action	Yes
Validity	int	Action Validity Period, Unit: Minutes	Yes
Name	string	Rule Name	No
ExtendsRule	array[RuleInfo]	Expansion Rules	No

RuleInfo

Field Name	Type	Description Information	Required
Field	string	Match Field	No
Content	string	Matching Content	No
Operator	string	Matching Operation	No

Example

Request Example


https://api.sigcalcloud.com/?Action=DescribeAntiCCRules
&ProjectId=org-xxx
&Domain=www.test.com
&FullDomain=OGdQttGC

Response Example


{
  "Action": "DescribeAntiCCRulesResponse",
  "Res": {
    "Max": 30,
    "Mode": "normal",
    "Rules": [
      {
        "Action": "forbidden",
        "Duration": 10,
        "Id": 43804,
        "Mode": "equal",
        "Reqs": 2,
        "Uri": "/index.html",
        "Validity": 60
      },
      {
        "Action": "forbidden",
        "Duration": 10,
        "Id": 44451,
        "Mode": "equal",
        "Reqs": 20,
        "Uri": "/index.html",
        "Validity": 60
      }
    ],
    "State": "on"
  },
  "RetCode": 0
}