调用DescribeSchedulerRules查询流量调度器的调度规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSchedulerRules

要执行的操作。取值:DescribeSchedulerRules

PageSize Integer 10

页面显示的记录数量。

RegionId String cn-hangzhou

DDoS高防实例所属的地域ID。取值:

  • cn-hangzhou:表示DDoS高防(新BGP)服务
  • ap-southeast-1:表示DDoS高防(国际)服务
ResourceGroupId String default

DDoS高防实例在资源管理产品中所属的资源组ID。默认为空,即属于默认资源组。

RuleName String testrule

规则名称。

PageNumber Integer 1

分页查询请求时返回的页码。例如,查询第一页的返回结果,则填写1

返回数据

名称 类型 示例值 描述
RequestId String 11C55595-1757-4B17-9ACE-4ACB68C2D989

本次请求的ID。

SchedulerRules Array of SchedulerRule

流量调度规则信息。

Cname String 4eru5229a843****.aliyunddos0001.com

CNAME值。

Param Struct

全球加速实例联动DDoS高防的规则。

ParamData Struct

联动资源。

CloudInstanceId String ga-bp1htlajy5509rc99****

全球加速实例的ID。

ParamType String GA

联动资源的类型。取值:GA,表示全球加速实例。

RuleName String doctest

规则名称。

RuleType String 6

规则类型。取值:

  • 2:阶梯防护
  • 3:出海加速
  • 5:CDN联动
  • 6:云产品联动
Rules Array of Rule

规则列表。

Priority Integer 100

规则优先级。

RegionId String 1

地域ID。

说明 仅在阶梯防护规则(RuleType2)中返回。
RestoreDelay Integer 60

回切时间,单位为分钟。

Status Integer 0

规则生效状态。取值:

  • 0:未生效
  • 1:生效
Type String A

资源地址的格式。取值:

  • A:IPv4地址
  • CNAME:CNAME地址
Value String 203.***.***.39

资源地址。

ValueType Integer 1

资源地址类型。取值:

  • 1:DDoS高防IP
  • 2:(阶梯防护)云资源IP
  • 3:(出海加速)加速线路IP
  • 5:(CDN联动)加速域名
  • 6:(云产品联动)云资源IP
TotalCount String 1

流量调度规则的总数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSchedulerRules
&PageSize=10
&<公共请求参数>

正常返回示例

XML 格式

<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>

JSON 格式

{
    "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"
        }
    ]
}

错误码

访问错误中心查看更多错误码。