调用DescribeSceneDefensePolicies查询定制场景策略的详细配置。
使用说明
本接口用于查询已创建的定制场景策略的详细配置,例如,策略的状态、防护对象、防护规则等。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeSceneDefensePolicies |
要执行的操作。取值:DescribeSceneDefensePolicies。 |
Template | String | 否 | promotion |
要查询的策略使用的模板类型。取值:
|
Status | String | 否 | 1 |
要查询的策略的生效状态。取值:
|
RegionId | String | 否 | cn-hangzhou |
DDoS高防实例所属地域ID。取值:
|
ResourceGroupId | String | 否 | rg-acfm2pz25js**** |
DDoS高防实例在资源管理服务中所属的资源组ID。 不设置该参数表示默认资源组。 |
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Success | Boolean | true |
本次请求是否成功调用成功。取值:
|
RequestId | String | F65DF043-E0EB-4796-9467-23DDCDF92C1D |
本次请求的ID。 |
Policies | Array of Policy |
定制场景策略的详细配置。 |
|
Done | Integer | 1 |
策略执行状态。取值:
|
EndTime | Long | 1586016000000 |
策略结束生效的时间。使用时间戳表示,单位:毫秒。 |
Status | Integer | 1 |
策略的生效状态。取值:
|
StartTime | Long | 1585670400000 |
策略开始生效的时间。使用时间戳表示,单位:毫秒。 |
ObjectCount | Integer | 1 |
策略的防护对象数量。 |
Template | String | promotion |
策略使用的模板类型。取值:
|
PolicyId | String | 321a-fd31-df51-**** |
策略ID。 |
Name | String | testpolicy |
策略名称。 |
RuntimePolicies | Array of Policy |
策略运行规则。 |
|
Status | Integer | 3 |
策略运行状态。取值:
|
oldValue | String | {"cc_rule_enable": true} |
策略生效前的防护规则。 PolicyType为1时,取值:{"cc_rule_enable": true},表示启用了频率控制。 PolicyType为2时,取值:{"ai_rule_enable": 1},表示启用了AI智能防护。 |
NewValue | String | {"cc_rule_enable": false } |
策略生效时的防护规则。 PolicyType为1时,取值:{"cc_rule_enable": false },表示禁用频率控制。 PolicyType为2时,取值:{"ai_rule_enable": 0},表示禁用AI智能防护。 |
PolicyType | Integer | 1 |
策略生效时触发的防护功能变更类型。取值:
|
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeSceneDefensePolicies
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeSceneDefensePoliciesResponse>
<Success>true</Success>
<RequestId>F65DF043-E0EB-4796-9467-23DDCDF92C1D</RequestId>
<Policies>
<Done>1</Done>
<EndTime>1586016000000</EndTime>
<Status>1</Status>
<StartTime>1585670400000</StartTime>
<ObjectCount>1</ObjectCount>
<Template>promotion</Template>
<PolicyId>321a-fd31-df51-****</PolicyId>
<Name>testpolicy</Name>
<RuntimePolicies>
<Status>3</Status>
<oldValue>{"cc_rule_enable": true}</oldValue>
<NewValue>{"cc_rule_enable": false }</NewValue>
<PolicyType>1</PolicyType>
</RuntimePolicies>
</Policies>
</DescribeSceneDefensePoliciesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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
} ]
} ]
}
错误码
访问错误中心查看更多错误码。