获取当前阿里云账号下WAF实例的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-waf:DescribeInstance |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
WAF 实例所属地域。取值：
|
cn-hangzhou |
| ResourceManagerResourceGroupId |
string |
否 |
阿里云资源组 ID。 |
rg-acfm***q |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Status |
integer |
实例的当前状态，取值：
|
1 |
| Details |
object |
实例详情。 |
|
| DefenseObjectInGroupMaxCount |
integer |
一个防护组内包含的防护对象的最大数量。 |
100 |
| Tamperproof |
boolean |
是否支持网页防篡改。取值：
|
true |
| BotApp |
string |
是否支持 App 防爬场景化防护。取值：
|
true |
| IpBlacklistRuleInTemplateMaxCount |
integer |
单个黑名单模板中包含的防护规则的最大数量。 |
100 |
| WhitelistRuleCondition |
string |
白名单规则匹配字段。更多信息，请参见 CreateDefenseRule 中白名单规则（whitelist）conditions的参数描述。 |
URL |
| CustomRuleCondition |
string |
自定义规则匹配条件。更多信息，请参见 CreateDefenseRule 中自定义规则（custom_acl）conditions的参数描述。 |
URL |
| CustomResponse |
boolean |
是否支持自定义响应。取值：
|
true |
| HttpPorts |
string |
HTTP 端口可用范围。更多信息，请参见 WAF 支持的端口范围。 |
80 |
| Gslb |
boolean |
是否支持 GSLB。取值：
|
true |
| Ipv6 |
boolean |
是否支持 IPv6。取值：
|
true |
| Bot |
boolean |
是否支持 Bot 管理。取值：
|
true |
| CustomRule |
boolean |
是否支持自定义规则。取值：
|
true |
| IpBlacklist |
boolean |
是否支持 IP 黑名单。取值：
|
true |
| CnameResourceMaxCount |
integer |
可添加的 CNAME 的最大数量。 |
1000 |
| BackendMaxCount |
integer |
可配置的回源 IP 的最大数量。 |
20 |
| ExclusiveIp |
boolean |
是否支持独享 IP。取值：
|
true |
| CustomResponseRuleInTemplateMaxCount |
integer |
单个自定义响应模板中包含的防护规则的最大数量。 |
100 |
| IpBlacklistIpInRuleMaxCount |
integer |
黑名单规则中可添加 IP 的最大数量。 |
200 |
| AclRuleMaxIpCount |
integer |
匹配内容中可添加 IP 的最大数量。关于匹配内容的更多说明，请参见匹配条件说明。 |
100 |
| BotTemplateMaxCount |
integer |
可配置的 Bot 管理防护模板的最大数量。 |
50 |
| DefenseGroupMaxCount |
integer |
可配置的防护组的最大数量。 |
100 |
| VastIpBlacklistInFileMaxCount |
integer |
单次批量导入 IP 黑名单的最大数量。 |
2,000 |
| AntiScanTemplateMaxCount |
integer |
可配置的扫描防护模板的最大数量。 |
20 |
| WhitelistLogical |
string |
白名单规则逻辑符。更多信息，请参见 CreateDefenseRule 中白名单规则（whitelist）conditions的参数描述。 |
contain |
| CustomRuleTemplateMaxCount |
integer |
可配置的自定义规则模板的最大数量。 |
20 |
| TamperproofTemplateMaxCount |
integer |
可配置的网页防篡改防护模板的最大数量。 |
50 |
| IpBlacklistTemplateMaxCount |
integer |
可配置的黑名单模板的最大数量。 |
20 |
| HttpsPorts |
string |
HTTPS 端口可用范围。更多信息，请参见 WAF 支持的端口范围。 |
443 |
| DlpTemplateMaxCount |
integer |
可配置的信息泄露防护模板的最大数量。 |
50 |
| CustomRuleRatelimitor |
string |
自定义规则限速对象。 |
header |
| DefenseObjectMaxCount |
integer |
可配置的防护对象的最大数量。 |
20,000 |
| Dlp |
boolean |
是否支持信息泄露防护。取值：
|
true |
| DefenseObjectInTemplateMaxCount |
integer |
一个模板内关联的防护对象的最大数量。 |
100 |
| CustomRuleAction |
string |
自定义规则包含的字符串。 |
block |
| TamperproofRuleInTemplateMaxCount |
integer |
单个网页防篡改模板中包含的防护规则的最大数量。 |
50 |
| DlpRuleInTemplateMaxCount |
integer |
单个信息泄露防护模板中包含的防护规则的最大数量。 |
50 |
| WhitelistTemplateMaxCount |
integer |
可配置的白名单模板的最大数量。 |
20 |
| MajorProtection |
boolean |
是否支持重保场景防护。取值：
|
true |
| BaseWafGroupRuleTemplateMaxCount |
integer |
可配置的基础防护规则模板的最大数量。 |
20 |
| BotWeb |
string |
是否支持网页防爬场景化防护。取值：
|
true |
| CustomRuleInTemplateMaxCount |
integer |
单个自定义规则模板中包含的防护规则的最大数量。 |
100 |
| VastIpBlacklistInOperationMaxCount |
integer |
单次页面添加 IP 黑名单的最大数量。 |
500 |
| WhitelistRuleInTemplateMaxCount |
integer |
单个白名单模板中包含的防护规则的最大数量。 |
100 |
| AntiScan |
boolean |
是否支持扫描防护。取值：
|
true |
| CustomResponseTemplateMaxCount |
integer |
可配置的自定义响应模板的最大数量。 |
20 |
| BaseWafGroupRuleInTemplateMaxCount |
integer |
单个基础防护规则模板中包含的防护规则的最大数量。 |
100 |
| MajorProtectionTemplateMaxCount |
integer |
可配置的重保场景防护模板的最大数量。 |
20 |
| BaseWafGroup |
boolean |
是否支持基础防护规则。取值：
|
true |
| Whitelist |
boolean |
是否支持 IP 白名单。取值：
|
true |
| LogService |
boolean |
是否支持日志服务。取值：
|
true |
| VastIpBlacklistMaxCount |
integer |
单用户可配置的 IP 黑名单的最大数量。 |
50,000 |
| RequestId |
string |
本次请求的 ID。 |
66A98669-CC6E-4F3E-80A6-3014697B11AE |
| EndTime |
integer |
实例到期时间。 |
4809859200000 |
| InstanceId |
string |
WAF 实例 ID。 |
waf-cn-xxx |
| InDebt |
string |
当前实例是否欠费：
|
1 |
| StartTime |
integer |
购买时间。格式为 Unix 时间戳（UTC 时间），单位为毫秒。 |
1668496310000 |
| RegionId |
string |
WAF 实例所属地域。取值：
|
cn-hangzhou |
| PayType |
string |
实例的付费类型。取值：
|
POSTPAY |
| Edition |
string |
WAF 版本。 |
default_version |
示例
正常返回示例
JSON格式
{
"Status": 1,
"Details": {
"DefenseObjectInGroupMaxCount": 100,
"Tamperproof": true,
"BotApp": "true",
"IpBlacklistRuleInTemplateMaxCount": 100,
"WhitelistRuleCondition": "URL",
"CustomRuleCondition": "URL",
"CustomResponse": true,
"HttpPorts": "80",
"Gslb": true,
"Ipv6": true,
"Bot": true,
"CustomRule": true,
"IpBlacklist": true,
"CnameResourceMaxCount": 1000,
"BackendMaxCount": 20,
"ExclusiveIp": true,
"CustomResponseRuleInTemplateMaxCount": 100,
"IpBlacklistIpInRuleMaxCount": 200,
"AclRuleMaxIpCount": 100,
"BotTemplateMaxCount": 50,
"DefenseGroupMaxCount": 100,
"VastIpBlacklistInFileMaxCount": 0,
"AntiScanTemplateMaxCount": 20,
"WhitelistLogical": "contain",
"CustomRuleTemplateMaxCount": 20,
"TamperproofTemplateMaxCount": 50,
"IpBlacklistTemplateMaxCount": 20,
"HttpsPorts": "443",
"DlpTemplateMaxCount": 50,
"CustomRuleRatelimitor": "header",
"DefenseObjectMaxCount": 0,
"Dlp": true,
"DefenseObjectInTemplateMaxCount": 100,
"CustomRuleAction": "block",
"TamperproofRuleInTemplateMaxCount": 50,
"DlpRuleInTemplateMaxCount": 50,
"WhitelistTemplateMaxCount": 20,
"MajorProtection": true,
"BaseWafGroupRuleTemplateMaxCount": 20,
"BotWeb": "true",
"CustomRuleInTemplateMaxCount": 100,
"VastIpBlacklistInOperationMaxCount": 500,
"WhitelistRuleInTemplateMaxCount": 100,
"AntiScan": true,
"CustomResponseTemplateMaxCount": 20,
"BaseWafGroupRuleInTemplateMaxCount": 100,
"MajorProtectionTemplateMaxCount": 20,
"BaseWafGroup": true,
"Whitelist": true,
"LogService": true,
"VastIpBlacklistMaxCount": 0
},
"RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
"EndTime": 4809859200000,
"InstanceId": "waf-cn-xxx",
"InDebt": "1",
"StartTime": 1668496310000,
"RegionId": "cn-hangzhou",
"PayType": "POSTPAY",
"Edition": "default_version"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。