调用DescribeInstance获取WAF实例详情_Web应用防火墙(WAF)-阿里云帮助中心

获取当前阿里云账号下WAF实例的详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-waf:DescribeInstance	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	66A98669-CC6E-4F3E-80A6-3014697B11AE
InstanceId	string	WAF 实例 ID。	waf-cn-xxx
RegionId	string	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
Edition	string	WAF 版本。	default_version
Details	object	实例详情。
Gslb	boolean	是否支持 GSLB。取值： true：表示支持。 false：表示不支持。	true
Ipv6	boolean	是否支持 IPv6。取值： true：表示支持。 false：表示不支持。	true
ExclusiveIp	boolean	是否支持独享 IP。取值： true：表示支持。 false：表示不支持。	true
BackendMaxCount	long	可配置的回源 IP 的最大数量。	20
CnameResourceMaxCount	long	可添加的 CNAME 的最大数量。	1000
LogService	boolean	是否支持日志服务。取值： true：表示支持。 false：表示不支持。	true
DefenseObjectMaxCount	long	可配置的防护对象的最大数量。	20,000
DefenseGroupMaxCount	long	可配置的防护组的最大数量。	100
DefenseObjectInGroupMaxCount	long	一个防护组内包含的防护对象的最大数量。	100
DefenseObjectInTemplateMaxCount	long	一个模板内关联的防护对象的最大数量。	100
BaseWafGroup	boolean	是否支持基础防护规则。取值： true：表示支持。 false：表示不支持。	true
BaseWafGroupRuleTemplateMaxCount	long	可配置的基础防护规则模板的最大数量。	20
BaseWafGroupRuleInTemplateMaxCount	long	单个基础防护规则模板中包含的防护规则的最大数量。	100
Whitelist	boolean	是否支持 IP 白名单。取值： true：表示支持。 false：表示不支持。	true
WhitelistTemplateMaxCount	long	可配置的白名单模板的最大数量。	20
WhitelistRuleInTemplateMaxCount	long	单个白名单模板中包含的防护规则的最大数量。	100
WhitelistRuleCondition	string	白名单规则匹配字段。更多信息，请参见 CreateDefenseRule 中白名单规则（whitelist）的 conditions 参数描述。	URL
WhitelistLogical	string	白名单规则逻辑符。更多信息，请参见 CreateDefenseRule 中白名单规则（whitelist）的 conditions 参数描述。	contain
IpBlacklist	boolean	是否支持 IP 黑名单。取值： true：表示支持。 false：表示不支持。	true
IpBlacklistTemplateMaxCount	long	可配置的黑名单模板的最大数量。	20
IpBlacklistRuleInTemplateMaxCount	long	单个黑名单模板中包含的防护规则的最大数量。	100
IpBlacklistIpInRuleMaxCount	long	黑名单规则中可添加 IP 的最大数量。	200
CustomRule	boolean	是否支持自定义规则。取值： true：表示支持。 false：表示不支持。	true
CustomRuleTemplateMaxCount	long	可配置的自定义规则模板的最大数量。	20
CustomRuleInTemplateMaxCount	long	单个自定义规则模板中包含的防护规则的最大数量。	100
CustomRuleCondition	string	自定义规则匹配条件。更多信息，请参见 CreateDefenseRule 中自定义规则（custom_acl）的 conditions 参数描述。	URL
CustomRuleRatelimitor	string	自定义规则限速对象。	header
CustomRuleAction	string	自定义规则包含的字符串。	block
AntiScan	boolean	是否支持扫描防护。取值： true：表示支持。 false：表示不支持。	true
AntiScanTemplateMaxCount	long	可配置的扫描防护模板的最大数量。	20
CustomResponse	boolean	是否支持自定义响应。取值： true：表示支持。 false：表示不支持。	true
CustomResponseTemplateMaxCount	long	可配置的自定义响应模板的最大数量。	20
CustomResponseRuleInTemplateMaxCount	long	单个自定义响应模板中包含的防护规则的最大数量。	100
HttpPorts	string	HTTP 端口可用范围。更多信息，请参见 WAF 支持的端口范围。	80
HttpsPorts	string	HTTPS 端口可用范围。更多信息，请参见 WAF 支持的端口范围。	443
AclRuleMaxIpCount	long	匹配内容中可添加 IP 的最大数量。关于匹配内容的更多说明，请参见匹配条件说明。	100
MajorProtection	boolean	是否支持重保场景防护。取值： true：表示支持。 false：表示不支持。	true
MajorProtectionTemplateMaxCount	long	可配置的重保场景防护模板的最大数量。	20
VastIpBlacklistMaxCount	long	单用户可配置的 IP 黑名单的最大数量。	50,000
VastIpBlacklistInFileMaxCount	long	单次批量导入 IP 黑名单的最大数量。	2,000
VastIpBlacklistInOperationMaxCount	long	单次页面添加 IP 黑名单的最大数量。	500
Bot	boolean	是否支持 Bot 管理。取值： true：表示支持。 false：表示不支持。	true
Tamperproof	boolean	是否支持网页防篡改。取值： true：表示支持。 false：表示不支持。	true
Dlp	boolean	是否支持信息泄露防护。取值： true：表示支持。 false：表示不支持。	true
BotTemplateMaxCount	long	可配置的 Bot 管理防护模板的最大数量。	50
TamperproofTemplateMaxCount	long	可配置的网页防篡改防护模板的最大数量。	50
TamperproofRuleInTemplateMaxCount	long	单个网页防篡改模板中包含的防护规则的最大数量。	50
DlpTemplateMaxCount	long	可配置的信息泄露防护模板的最大数量。	50
DlpRuleInTemplateMaxCount	long	单个信息泄露防护模板中包含的防护规则的最大数量。	50
BotApp	string	是否支持 App 防爬场景化防护。取值： true：表示支持。 false：表示不支持。	true
BotWeb	string	是否支持网页防爬场景化防护。取值： true：表示支持。 false：表示不支持。	true
EndTime	long	实例到期时间。	4809859200000
Status	integer	实例的当前状态，取值： 1：表示正常。 2：表示到期。 3：表示释放。	1
PayType	string	实例的付费类型。取值： POSTPAY：表示已开通按量付费 WAF 实例。 PREPAY：表示已开通包年包月 WAF 实例。	POSTPAY
InDebt	string	当前实例是否欠费： 0：表示正常。 1：表示已欠费。	1
StartTime	long	购买时间，格式为 Unix 时间戳（UTC 时间），单位为毫秒。	1668496310000

示例

正常返回示例

JSON格式

{
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "InstanceId": "waf-cn-xxx",
  "RegionId": "cn-hangzhou",
  "Edition": "default_version",
  "Details": {
    "Gslb": true,
    "Ipv6": true,
    "ExclusiveIp": true,
    "BackendMaxCount": 20,
    "CnameResourceMaxCount": 1000,
    "LogService": true,
    "DefenseObjectMaxCount": 0,
    "DefenseGroupMaxCount": 100,
    "DefenseObjectInGroupMaxCount": 100,
    "DefenseObjectInTemplateMaxCount": 100,
    "BaseWafGroup": true,
    "BaseWafGroupRuleTemplateMaxCount": 20,
    "BaseWafGroupRuleInTemplateMaxCount": 100,
    "Whitelist": true,
    "WhitelistTemplateMaxCount": 20,
    "WhitelistRuleInTemplateMaxCount": 100,
    "WhitelistRuleCondition": "URL",
    "WhitelistLogical": "contain",
    "IpBlacklist": true,
    "IpBlacklistTemplateMaxCount": 20,
    "IpBlacklistRuleInTemplateMaxCount": 100,
    "IpBlacklistIpInRuleMaxCount": 200,
    "CustomRule": true,
    "CustomRuleTemplateMaxCount": 20,
    "CustomRuleInTemplateMaxCount": 100,
    "CustomRuleCondition": "URL",
    "CustomRuleRatelimitor": "header",
    "CustomRuleAction": "block",
    "AntiScan": true,
    "AntiScanTemplateMaxCount": 20,
    "CustomResponse": true,
    "CustomResponseTemplateMaxCount": 20,
    "CustomResponseRuleInTemplateMaxCount": 100,
    "HttpPorts": "80",
    "HttpsPorts": "443",
    "AclRuleMaxIpCount": 100,
    "MajorProtection": true,
    "MajorProtectionTemplateMaxCount": 20,
    "VastIpBlacklistMaxCount": 0,
    "VastIpBlacklistInFileMaxCount": 0,
    "VastIpBlacklistInOperationMaxCount": 500,
    "Bot": true,
    "Tamperproof": true,
    "Dlp": true,
    "BotTemplateMaxCount": 50,
    "TamperproofTemplateMaxCount": 50,
    "TamperproofRuleInTemplateMaxCount": 50,
    "DlpTemplateMaxCount": 50,
    "DlpRuleInTemplateMaxCount": 50,
    "BotApp": "true",
    "BotWeb": "true"
  },
  "EndTime": 4809859200000,
  "Status": 1,
  "PayType": "POSTPAY",
  "InDebt": "1",
  "StartTime": 1668496310000
}

错误码

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