全部產品
Search
文件中心

Web Application Firewall:DescribeInstance

更新時間:Aug 12, 2026

取得目前阿里雲帳號下 WAF 執行個體的詳細資訊。

調試

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

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeInstance

get

*全部資源。

*

  • acs:ResourceGroupId

請求參數

名稱

類型

必填

描述

樣本值

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 黑名單的最大數量。

2000

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

可設定的防護物件的最大數量。

20000

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 黑名單的最大數量。

50000

FreeQps

integer

包年包月版本內免費 QPS 值。更多資訊,請參閱 WAF3.0 版本說明

1000

ExtendQps

integer

訂閱制版本擴充的 QPS 值。更多資訊,請參閱 WAF3.0 版本說明

10000

ElasticQps

integer

包年包月版本彈性後付費的 QPS 值。更多資訊,請參閱 WAF3.0 版本說明

2000

QpsBillingCap

integer

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

2000

HybridCloud

boolean

混合雲是否開啟。

true

HybridCloudNodeExtend

integer

混合雲擴充節點數。

3

Apisec

boolean

API 安全是否開啟。

false

AgenticApisec

boolean

Agentic API 安全是否開啟。

true

ResourceDirectory

boolean

是否支援多帳號統一管理。

true

RequestId

string

本次請求的 ID。

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

EndTime

integer

執行個體到期時間。Unix 時間戳記格式,單位:毫秒(ms)。

4809859200000

InstanceId

string

WAF 執行個體 ID。

waf-cn-xxx

InDebt

string

目前執行個體是否欠費:

1

StartTime

integer

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

1668496310000

RegionId

string

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

cn-hangzhou

PayType

string

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

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": 2000,
    "AntiScanTemplateMaxCount": 20,
    "WhitelistLogical": "contain",
    "CustomRuleTemplateMaxCount": 20,
    "TamperproofTemplateMaxCount": 50,
    "IpBlacklistTemplateMaxCount": 20,
    "HttpsPorts": "443",
    "DlpTemplateMaxCount": 50,
    "CustomRuleRatelimitor": "header",
    "DefenseObjectMaxCount": 20000,
    "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": 50000,
    "FreeQps": 1000,
    "ExtendQps": 10000,
    "ElasticQps": 2000,
    "QpsBillingCap": 2000,
    "HybridCloud": true,
    "HybridCloudNodeExtend": 3,
    "Apisec": false,
    "AgenticApisec": true,
    "ResourceDirectory": true
  },
  "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"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情