全部产品
Search
文档中心

DDoS 防护:DescribeSceneDefensePolicies - 查询定制场景策略的详细信息

更新时间:Apr 16, 2024

查询定制场景策略的详细配置。

接口说明

本接口用于查询已创建的定制场景策略的详细配置,例如,策略的状态、防护对象、防护规则等。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Templatestring

要查询的策略使用的模板类型。取值:

  • promotion:表示重大活动模板。
  • bypass:表示全量转发模板。
promotion
Statusstring

要查询的策略的生效状态。取值:

  • 0:表示已被禁用。
  • 1:表示等待生效。
  • 2:表示生效中。
  • 3:表示已过期。
1
ResourceGroupIdstring

DDoS 高防实例在资源管理服务中所属的资源组 ID。

不设置该参数表示默认资源组。

rg-acfm2pz25js****

调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用 API 的请求格式,请参见本文示例中的请求示例。

返回参数

名称类型描述示例值
object
Successboolean

本次请求是否成功调用成功。取值:

  • true:表示调用成功。
  • false:表示调用失败。
true
RequestIdstring

本次请求的 ID。

F65DF043-E0EB-4796-9467-23DDCDF92C1D
Policiesobject []

定制场景策略的详细配置。

Doneinteger

策略执行状态。取值:

  • 1:表示未执行或执行完成。
  • 0:表示执行中。
  • -1:表示执行失败。
1
EndTimelong

策略结束生效的时间。使用时间戳表示,单位:毫秒。

1586016000000
Statusinteger

策略的生效状态。取值:

  • 0:表示已被禁用。
  • 1:表示等待生效。
  • 2:表示生效中。
  • 3:表示已过期。
1
StartTimelong

策略开始生效的时间。使用时间戳表示,单位:毫秒。

1585670400000
ObjectCountinteger

策略的防护对象数量。

1
Templatestring

策略使用的模板类型。取值:

  • promotion:表示重大活动模板。
  • bypass:表示全量转发模板。
promotion
PolicyIdstring

策略 ID。

321a-fd31-df51-****
Namestring

策略名称。

testpolicy
RuntimePoliciesobject []

策略运行规则。

Statusinteger

策略运行状态。取值:

  • 0:表示未下发或策略恢复成功。
  • 1:表示正在生效中(策略生效)。
  • 2:表示正在恢复中(策略恢复)。
  • 3:表示策略生效成功 。
  • 4:表示策略生效失败。
  • 5:表示策略恢复失败。
  • 6:表示策略对应对象的配置不存在(可能已删除)。
3
oldValuestring

策略生效前的防护规则。

PolicyType1 时,取值:{"cc_rule_enable": true},表示启用了频率控制。

PolicyType2 时,取值:{"ai_rule_enable": 1},表示启用了 AI 智能防护。

{"cc_rule_enable": true}
NewValuestring

策略生效时的防护规则。

PolicyType1 时,取值:{"cc_rule_enable": false },表示禁用频率控制。

PolicyType2 时,取值:{"ai_rule_enable": 0},表示禁用 AI 智能防护。

{"cc_rule_enable": false }
PolicyTypeinteger

策略生效时触发的防护功能变更类型。取值:

  • 1:表示频率控制功能变更。
  • 2:表示 AI 智能防护功能变更。
1

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "F65DF043-E0EB-4796-9467-23DDCDF92C1D",
  "Policies": [
    {
      "Done": 1,
      "EndTime": 1586016000000,
      "Status": 1,
      "StartTime": 1585670400000,
      "ObjectCount": 1,
      "Template": "promotion",
      "PolicyId": "321a-fd31-df51-****",
      "Name": "testpolicy",
      "RuntimePolicies": [
        {
          "Status": 3,
          "oldValue": "{\"cc_rule_enable\": true}",
          "NewValue": "{\"cc_rule_enable\": false }",
          "PolicyType": 1
        }
      ]
    }
  ]
}

错误码

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