全部產品
Search
文件中心

Web Application Firewall:DescribeInstance - 擷取WAF執行個體詳情

更新時間:Dec 05, 2025

擷取當前阿里雲帳號下WAF執行個體的詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

WAF 執行個體所屬地區。取值:

  • cn-hangzhou:表示中國內地。

  • ap-southeast-1:表示非中國內地。

cn-hangzhou

ResourceManagerResourceGroupId

string

阿里雲資源群組 ID。

rg-acfm***q

返回參數

名稱

類型

描述

樣本值

object

Status

integer

執行個體的目前狀態,取值:

  • 1:表示正常。

  • 2:表示到期。

  • 3:表示釋放。

1

Details

object

執行個體詳情。

DefenseObjectInGroupMaxCount

integer

一個防護組內包含的防護對象的最大數量。

100

Tamperproof

boolean

是否支援網頁防篡改。取值:

  • true:表示支援。

  • false:表示不支援。

true

BotApp

string

是否支援 App 防爬情境化防護。取值:

  • true:表示支援。

  • false:表示不支援。

true

IpBlacklistRuleInTemplateMaxCount

integer

單個黑名單模板中包含的防護規則的最大數量。

100

WhitelistRuleCondition

string

白名單規則匹配欄位。更多資訊,請參見 CreateDefenseRule白名單規則(whitelist)conditions的參數描述。

URL

CustomRuleCondition

string

自訂規則匹配條件。更多資訊,請參見 CreateDefenseRule自訂規則(custom_acl)conditions的參數描述。

URL

CustomResponse

boolean

是否支援自訂響應。取值:

  • true:表示支援。

  • false:表示不支援。

true

HttpPorts

string

HTTP 連接埠可用範圍。更多資訊,請參見 WAF 支援的連接埠範圍

80

Gslb

boolean

是否支援 GSLB。取值:

  • true:表示支援。

  • false:表示不支援。

true

Ipv6

boolean

是否支援 IPv6。取值:

  • true:表示支援。

  • false:表示不支援。

true

Bot

boolean

是否支援 Bot 管理。取值:

  • true:表示支援。

  • false:表示不支援。

true

CustomRule

boolean

是否支援自訂規則。取值:

  • true:表示支援。

  • false:表示不支援。

true

IpBlacklist

boolean

是否支援 IP 黑名單。取值:

  • true:表示支援。

  • false:表示不支援。

true

CnameResourceMaxCount

integer

可添加的 CNAME 的最大數量。

1000

BackendMaxCount

integer

可配置的回源 IP 的最大數量。

20

ExclusiveIp

boolean

是否支援獨享 IP。取值:

  • true:表示支援。

  • false:表示不支援。

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:表示支援。

  • false:表示不支援。

true

DefenseObjectInTemplateMaxCount

integer

一個模板內關聯的防護對象的最大數量。

100

CustomRuleAction

string

自訂規則包含的字串。

block

TamperproofRuleInTemplateMaxCount

integer

單個網頁防篡改模板中包含的防護規則的最大數量。

50

DlpRuleInTemplateMaxCount

integer

單個資訊泄露防護模板中包含的防護規則的最大數量。

50

WhitelistTemplateMaxCount

integer

可配置的白名單模板的最大數量。

20

MajorProtection

boolean

是否支援重保情境防護。取值:

  • true:表示支援。

  • false:表示不支援。

true

BaseWafGroupRuleTemplateMaxCount

integer

可配置的基礎防護規則模板的最大數量。

20

BotWeb

string

是否支援網頁防爬情境化防護。取值:

  • true:表示支援。

  • false:表示不支援。

true

CustomRuleInTemplateMaxCount

integer

單個自訂規則模板中包含的防護規則的最大數量。

100

VastIpBlacklistInOperationMaxCount

integer

單次頁面添加 IP 黑名單的最大數量。

500

WhitelistRuleInTemplateMaxCount

integer

單個白名單模板中包含的防護規則的最大數量。

100

AntiScan

boolean

是否支援掃描防護。取值:

  • true:表示支援。

  • false:表示不支援。

true

CustomResponseTemplateMaxCount

integer

可配置的自訂響應模板的最大數量。

20

BaseWafGroupRuleInTemplateMaxCount

integer

單個基礎防護規則模板中包含的防護規則的最大數量。

100

MajorProtectionTemplateMaxCount

integer

可配置的重保情境防護模板的最大數量。

20

BaseWafGroup

boolean

是否支援基礎防護規則。取值:

  • true:表示支援。

  • false:表示不支援。

true

Whitelist

boolean

是否支援 IP 白名單。取值:

  • true:表示支援。

  • false:表示不支援。

true

LogService

boolean

是否支援Log Service。取值:

  • true:表示支援。

  • false:表示不支援。

true

VastIpBlacklistMaxCount

integer

單使用者可配置的 IP 黑名單的最大數量。

50,000

FreeQps

integer

訂用帳戶版本內免費 QPS 值。更多資訊,請參見WAF3.0 版本說明

說明

該參數在隨用隨付執行個體中無實際含義。

1000

ExtendQps

integer

訂用帳戶版本擴充的 QPS 值。更多資訊,請參見WAF3.0 版本說明

說明

該參數在隨用隨付執行個體中無實際含義。

10000

ElasticQps

integer

訂用帳戶版本彈性後付費的 QPS 值。更多資訊,請參見WAF3.0 版本說明

說明

該參數在隨用隨付執行個體中無實際含義。

2000

QpsBillingCap

integer

隨用隨付版本的 QPS 流量計費保護閾值。更多資訊,請參見隨用隨付的流量計費保護

說明

該參數在訂用帳戶執行個體中無實際含義。

2000

RequestId

string

本次請求的 ID。

66A98669-CC6E-4F3E-80A6-3014697B11AE

EndTime

integer

執行個體到期時間。

4809859200000

InstanceId

string

WAF 執行個體 ID。

waf-cn-xxx

InDebt

string

當前執行個體是否欠費:

  • 0:表示正常。

  • 1:表示已欠費。

1

StartTime

integer

購買時間。格式為 Unix 時間戳記(UTC 時間),單位為毫秒。

1668496310000

RegionId

string

WAF 執行個體所屬地區。取值:

  • cn-hangzhou:表示中國內地。

  • ap-southeast-1:表示非中國內地。

cn-hangzhou

PayType

string

執行個體的付費類型。取值:

  • POSTPAY:表示已開通隨用隨付 WAF 執行個體。

  • PREPAY:表示已開通訂用帳戶 WAF 執行個體。

POSTPAY

Edition

string

WAF 版本。

default_version

ProcessStatus

string

執行個體執行狀態。取值:

  • commodity_converting:表示商品轉換中。

  • commodity_convert_check_failed:表示商品轉換校正失敗。

  • commodity_convert_process_failed:表示商品轉換失敗。

  • order_create_failed:表示訂單建立失敗。

  • order_pending_payment:表示訂單待支付。

order_pending_payment

樣本

正常返回樣本

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,
    "FreeQps": 1000,
    "ExtendQps": 10000,
    "ElasticQps": 2000,
    "QpsBillingCap": 2000
  },
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "EndTime": 4809859200000,
  "InstanceId": "waf-cn-xxx",
  "InDebt": "1",
  "StartTime": 1668496310000,
  "RegionId": "cn-hangzhou",
  "PayType": "POSTPAY",
  "Edition": "default_version",
  "ProcessStatus": "order_pending_payment"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情