DescribeSchedulerRules - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the scheduling rules of Sec-Traffic Manager.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Association operation
yundun-ddoscoo:DescribeSchedulerRules	Read	DdosCoo acs:yundun-ddoscoo:{#regionId}:{#accountId}:*	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.	default
RuleName	string	No	The name of the rule.	testrule
PageNumber	integer	No	The number of the page to return. For example, to query the returned results on the first page, set the value to 1.	1
PageSize	integer	Yes	The number of entries to return on each page.	10

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	string	The total number of returned scheduling rules.	1
RequestId	string	The ID of the request.	11C55595-1757-4B17-9ACE-4ACB68C2D989
SchedulerRules	array	The information about the scheduling rule.
	object
RuleType	string	The type of the rule. Valid values: 2: tiered protection 3: network acceleration 5: Alibaba Cloud CDN (CDN) interaction 6: cloud service interaction	6
Cname	string	The Canonical Name (CNAME) record assigned by Sec-Traffic Manager for the scheduling rule.	4eru5229a843****.aliyunddos0001.com
RuleName	string	The name of the rule.	doctest
Rules	array	An array that consists of the rules.
	object
Type	string	The address type of the interaction resource. Valid values: A: IPv4 address CNAME: CNAME record	A
Status	integer	The status of the scheduling rule. Valid values: 0: disabled 1: enabled	0
Value	string	The address of the interaction resource.	203.*.*.39
ValueType	integer	The address type of the interaction resource. Valid values: 1: the IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance 2: the IP address of the interaction resource in the tiered protection scenario 3: the IP address that is used to accelerate access in the network acceleration scenario 5: the domain name that is configured in CDN in the CDN interaction scenario 6 the IP address of the interaction resource in the cloud service interaction scenario	1
Priority	integer	The priority of the rule.	100
RestoreDelay	integer	The waiting time of switching back. Unit: minutes.	60
RegionId	string	The ID of the region. NoteThis parameter is returned only if the RuleType parameter is set to 2.	1
Param	object	The scheduling rule for the Global Accelerator instance that interacts with Anti-DDoS Pro or Anti-DDoS Premium.
ParamType	string	The type of the interaction resource. Valid value: GA, which indicates that the Global Accelerator instance is used.	GA
ParamData	object	The interaction resource.
CloudInstanceId	string	The ID of the GA instance.	ga-bp1htlajy5509rc99****

Examples

Sample success responses

JSONformat

{
    "TotalCount": 1,
    "RequestId": "11C55595-1757-4B17-9ACE-4ACB68C2D989",
    "SchedulerRules": [
        {
            "Param": {
                "ParamData": {
                    "CloudInstanceId": "ga-bp1htlajy5509rc99****"
                },
                "ParamType": "GA"
            },
            "RuleType": 6,
            "Cname": "4eru5229a843****.aliyunddos0001.com",
            "Rules": [
                {
                    "Status": 0,
                    "Type": "A",
                    "RestoreDelay": 60,
                    "ValueType": 1,
                    "Priority": 100,
                    "Value": "203.***.***.39",
                    "RegionId": ""
                },
                {
                    "Status": 1,
                    "Type": "A",
                    "ValueType": 6,
                    "Priority": 50,
                    "Value": "47.***.***.47",
                    "RegionId": "cn-hangzhou"
                }
            ],
            "RuleName": "doctest"
        }
    ]
}

XMLformat

<?xml version="1.0" encoding="UTF-8" ?>
	<DescribeSchedulerRulesResponse>
		<TotalCount>1</TotalCount>
		<RequestId>11C55595-1757-4B17-9ACE-4ACB68C2D989</RequestId>
		<SchedulerRules>
			<Param>
				<ParamData>
					<CloudInstanceId>ga-bp1htlajy5509rc99****</CloudInstanceId>
				</ParamData>
				<ParamType>GA</ParamType>
			</Param>
			<RuleType>6</RuleType>
			<Cname>4eru5229a843****.aliyunddos0001.com</Cname>
			<Rules>
				<Status>0</Status>
				<Type>A</Type>
				<RestoreDelay>60</RestoreDelay>
				<ValueType>1</ValueType>
				<Priority>100</Priority>
				<Value>203.***.***.39</Value>
				<RegionId></RegionId>
			</Rules>
			<Rules>
				<Status>1</Status>
				<Type>A</Type>
				<ValueType>6</ValueType>
				<Priority>50</Priority>
				<Value>47.***.***.47</Value>
				<RegionId>cn-hangzhou</RegionId>
			</Rules>
			<RuleName>doctest</RuleName>
		</SchedulerRules>
	</DescribeSchedulerRulesResponse>

Error codes

For a list of error codes, visit the Service error codes.