调用DescribeSceneDefensePolicies查询定制场景策略的详细信息。

调试

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

请求参数

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

要执行的操作。取值:DescribeSceneDefensePolicies

Template String promotion

策略模板。取值:

  • promotion:重大活动
  • bypass:全量转发
Status String 1

策略生效状态。取值:

  • 0:禁用
  • 1:等待生效
  • 2:生效中
  • 3:过期
RegionId String cn-hangzhou

DDoS高防服务地域ID。取值:

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

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

返回数据

名称 类型 示例值 描述
Policies Array

定制场景策略的详细信息。

Done Integer 1

策略执行状态。取值:

  • 1:未执行或执行完成
  • 0:执行中
  • -1:执行失败
EndTime Long 1586016000000

生效结束时间。时间戳格式,单位:毫秒。

Name String testpolicy

策略名称。

ObjectCount Integer 1

防护对象数量。

PolicyId String 321a-fd31-df51-****

策略ID。

RuntimePolicies Array

策略运行规则。

NewValue String {"cc_rule_enable": false }

策略生效时的防护规则。

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

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

PolicyType Integer 1

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

  • 1:频率控制
  • 2:AI智能防护
Status Integer 3

策略运行状态。取值:

  • 0:未下发或策略恢复成功
  • 1:正在生效中(策略生效)
  • 2:正在恢复中(策略恢复)
  • 3:策略生效成功
  • 4:策略生效失败
  • 5:策略恢复失败
  • 6:策略对应对象的配置不存在(可能已删除)
oldValue String {"cc_rule_enable": true}

策略生效前的防护规则。

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

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

StartTime Long 1585670400000

生效开始时间。时间戳格式,单位:毫秒。

Status Integer 1

策略生效状态。取值:

  • 0:禁用
  • 1:等待生效
  • 2:生效中
  • 3:过期
Template String promotion

策略模板。取值:

  • promotion:重大活动
  • bypass:全量转发
RequestId String F65DF043-E0EB-4796-9467-23DDCDF92C1D

本次请求的ID。

Success Boolean true

是否成功调用、取值:

  • true:是
  • false:否

示例

请求示例

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

正常返回示例

XML 格式

<DescribeSceneDefensePoliciesResponse>
	  <Policies>
		    <PolicyId>321a-fd31-df51-****</PolicyId>
		    <Name>testpolicy</Name>
		    <Template>promotion</Template>
		    <StartTime>1585670400000</StartTime>
		    <EndTime>1586016000000</EndTime>
		    <Status>1</Status>
		    <ObjectCount>1</ObjectCount>
		    <Done>1</Done>
		    <RuntimePolicies>
			      <Status>4</Status>
			      <PolicyType>1</PolicyType>
			      <NewValue>
				        <cc_rule_enable>false</cc_rule_enable>
			      </NewValue>
			      <oldValue>
				        <cc_rule_enable>true</cc_rule_enable>
			      </oldValue>
		    </RuntimePolicies>
		    <RuntimePolicies>
			      <Status>3</Status>
			      <PolicyType>2</PolicyType>
			      <NewValue>
				        <ai_rule_enable>0</ai_rule_enable>
			      </NewValue>
			      <oldValue>
				        <ai_rule_enable>1</ai_rule_enable>
			      </oldValue>
		    </RuntimePolicies>
	  </Policies>
	  <Success>true</Success>
	  <RequestId>F65DF043-E0EB-4796-9467-23DDCDF92C1D</RequestId>
</DescribeSceneDefensePoliciesResponse>

JSON 格式

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

错误码

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