全部产品
Search

搜索本产品

    DDoS 防护：DescribeSchedulerRules - 查询流量调度器的调度规则

    文档中心

    DDoS 防护：DescribeSchedulerRules - 查询流量调度器的调度规则

    更新时间：Oct 23, 2024

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

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    yundun-ddoscoo:DescribeSchedulerRulesget
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    ResourceGroupIdstring否

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

    		default
    RuleNamestring否

    规则名称。

    		testrule
    PageNumberinteger否

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

    		1
    PageSizeinteger是

    页面显示的记录数量。

    		10

    返回参数

    名称类型描述示例值
    object
    TotalCountstring

    流量调度规则的总数。

    		1
    RequestIdstring

    本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

    		11C55595-1757-4B17-9ACE-4ACB68C2D989
    SchedulerRulesarray<object>

    流量调度规则信息。

    SchedulerRuleobject
    RuleTypestring

    规则类型。取值：

    • 2：阶梯防护
    • 3：出海加速
    • 5：CDN 联动
    • 6：云产品联动
    • 8：安全加速
    		2
    Cnamestring

    CNAME 值。

    		4eru5229a843****.aliyunddos0001.com
    RuleNamestring

    规则名称。

    		doctest
    Rulesarray<object>

    规则列表。

    Ruleobject
    Typestring

    资源地址的格式。取值：

    • A：IPv4 地址
    • CNAME：CNAME 地址
    		A
    Statusinteger

    规则生效状态。取值：

    • 0：未生效
    • 1：生效
    		0
    Valuestring

    资源地址。

    		203.***.***.39
    ValueTypeinteger

    资源地址类型。取值：

    • 1：DDoS 高防 IP
    • 2：（阶梯防护）云资源 IP
    • 3：（出海加速）加速线路 IP
    • 5：（CDN 联动）加速域名
    • 6：（云产品联动）云资源 IP
    • 8：（安全加速）安全加速 P
    		1
    Priorityinteger

    规则优先级。

    		100
    RestoreDelayinteger

    回切时间，单位为分钟。

    		60
    RegionIdstring

    地域 ID。

    说明 仅当 RuleType（即阶梯防护规则）取值为 2 时返回。
    		1
    Paramobject

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

    ParamTypestring

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

    		GA
    ParamDataobject

    联动资源。

    CloudInstanceIdstring

    全球加速实例的 ID。

    		ga-bp1htlajy5509rc99****

    示例

    正常返回示例

    JSON格式

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

    错误码

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