All Products
Search
Document Center

Web Application Firewall:DescribeInstance

Last Updated:Aug 13, 2026

Mengambil detail instans WAF dalam Akun Alibaba Cloud saat ini.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

yundun-waf:DescribeInstance

get

*Semua sumber daya.

*

  • acs:ResourceGroupId
None

Parameter permintaan

Parameter

Type

Required

Description

Example

RegionId

string

No

Wilayah tempat instans WAF berada. Nilai yang valid:

cn-hangzhou

ResourceManagerResourceGroupId

string

No

ID kelompok sumber daya Alibaba Cloud.

rg-acfm***q

Elemen respons

Element

Type

Description

Example

object

Status

integer

Status instans saat ini. Nilai yang valid:

  • 1: Normal.

  • 2: Kedaluwarsa.

  • 3: Dilepas.

1

Details

object

Detail instans.

DefenseObjectInGroupMaxCount

integer

Jumlah maksimum objek perlindungan yang dapat dimuat oleh satu kelompok perlindungan.

100

Tamperproof

boolean

Menentukan apakah pencegahan perusakan web didukung. Nilai yang valid:

true

BotApp

string

Menunjukkan apakah perlindungan spesifik skenario terhadap perayap aplikasi didukung. Nilai yang valid:

  • true: Didukung.

  • false: Tidak didukung.

true

IpBlacklistRuleInTemplateMaxCount

integer

Jumlah maksimum aturan perlindungan yang dapat dimuat oleh satu template daftar hitam IP.

100

WhitelistRuleCondition

string

Bidang pencocokan untuk aturan daftar putih. Untuk informasi selengkapnya, lihat deskripsi parameter kondisi aturan daftar putih (whitelist) di CreateDefenseRule.

URL

CustomRuleCondition

string

Kondisi pencocokan untuk aturan kustom. Untuk informasi selengkapnya, lihat deskripsi parameter kondisi aturan kustom (custom_acl) di CreateDefenseRule.

URL

CustomResponse

boolean

Menunjukkan apakah respons kustom didukung. Nilai yang valid:

  • true: Didukung.

  • false: Tidak didukung.

true

HttpPorts

string

Range port HTTP yang tersedia. Untuk informasi selengkapnya, lihat Port yang didukung oleh WAF.

80

Gslb

boolean

Menentukan apakah Global Server Load Balancing (GSLB) didukung. Nilai yang valid:

true

Ipv6

boolean

Menentukan apakah IPv6 didukung. Nilai yang valid:

true

Bot

boolean

Menentukan apakah manajemen bot didukung. Nilai yang valid:

true

CustomRule

boolean

Menentukan apakah aturan kustom didukung. Nilai yang valid:

  • true: Didukung.

  • false: Tidak didukung.

true

IpBlacklist

boolean

Menunjukkan apakah daftar hitam IP didukung. Nilai yang valid:

  • true: Didukung.

  • false: Tidak didukung.

true

CnameResourceMaxCount

integer

Jumlah maksimum CNAME yang dapat ditambahkan.

1000

BackendMaxCount

integer

Jumlah maksimum alamat IP origin yang dapat dikonfigurasi.

20

ExclusiveIp

boolean

Menentukan apakah alamat IP eksklusif didukung. Nilai yang valid:

true

CustomResponseRuleInTemplateMaxCount

integer

Jumlah maksimum aturan perlindungan yang dapat dimuat oleh satu template respons kustom.

100

IpBlacklistIpInRuleMaxCount

integer

Jumlah maksimum alamat IP yang dapat ditambahkan ke aturan daftar hitam.

200

AclRuleMaxIpCount

integer

Jumlah maksimum alamat IP yang dapat ditambahkan ke konten pencocokan. Untuk informasi lebih lanjut tentang konten pencocokan, lihat Deskripsi kondisi pencocokan.

100

BotTemplateMaxCount

integer

Jumlah maksimum template perlindungan manajemen bot yang dapat dikonfigurasi.

50

DefenseGroupMaxCount

integer

Jumlah maksimum kelompok perlindungan yang dapat dikonfigurasi.

100

VastIpBlacklistInFileMaxCount

integer

Jumlah maksimum alamat IP yang dapat diimpor ke daftar hitam IP dalam satu kali impor massal.

2000

AntiScanTemplateMaxCount

integer

Jumlah maksimum template perlindungan pemindaian yang dapat dikonfigurasi.

20

WhitelistLogical

string

Operator logika untuk aturan daftar putih. Untuk informasi selengkapnya, lihat deskripsi parameter kondisi aturan daftar putih (whitelist) di CreateDefenseRule.

contain

CustomRuleTemplateMaxCount

integer

Jumlah maksimum template aturan kustom yang dapat dikonfigurasi.

20

TamperproofTemplateMaxCount

integer

Jumlah maksimum template perlindungan pencegahan perusakan web yang dapat dikonfigurasi.

50

IpBlacklistTemplateMaxCount

integer

Jumlah maksimum template daftar hitam yang dapat dikonfigurasi.

20

HttpsPorts

string

Range port HTTPS yang tersedia. Untuk informasi selengkapnya, lihat Port yang didukung oleh WAF.

443

DlpTemplateMaxCount

integer

Jumlah maksimum template pencegahan kebocoran informasi yang dapat dikonfigurasi.

50

CustomRuleRatelimitor

string

Objek pembatasan laju untuk aturan kustom.

header

DefenseObjectMaxCount

integer

Jumlah maksimum objek perlindungan yang dapat dikonfigurasi.

20000

Dlp

boolean

Menentukan apakah pencegahan kebocoran data didukung. Nilai yang valid:

  • true: Didukung.

  • false: Tidak didukung.

true

DefenseObjectInTemplateMaxCount

integer

Jumlah maksimum objek perlindungan yang dapat dikaitkan dengan satu template.

100

CustomRuleAction

string

String yang disertakan dalam aturan kustom.

block

TamperproofRuleInTemplateMaxCount

integer

Jumlah maksimum aturan perlindungan yang dapat dimuat oleh satu template pencegahan perusakan web.

50

DlpRuleInTemplateMaxCount

integer

Jumlah maksimum aturan perlindungan yang dapat dimuat oleh satu template pencegahan kebocoran informasi.

50

WhitelistTemplateMaxCount

integer

Jumlah maksimum template daftar putih yang dapat dikonfigurasi.

20

MajorProtection

boolean

Menentukan apakah perlindungan event kritis didukung. Nilai yang valid:

  • true: Didukung.

  • false: Tidak didukung.

true

BaseWafGroupRuleTemplateMaxCount

integer

Jumlah maksimum template aturan perlindungan dasar yang dapat dikonfigurasi.

20

BotWeb

string

Menentukan apakah perlindungan spesifik skenario terhadap perayap web didukung. Nilai yang valid:

  • true: Didukung.

  • false: Tidak didukung.

true

CustomRuleInTemplateMaxCount

integer

Jumlah maksimum aturan perlindungan yang dapat dimuat oleh satu template aturan kustom.

100

VastIpBlacklistInOperationMaxCount

integer

Jumlah maksimum alamat IP yang dapat ditambahkan ke daftar hitam IP dalam satu operasi halaman.

500

WhitelistRuleInTemplateMaxCount

integer

Jumlah maksimum aturan perlindungan yang dapat dimuat oleh satu template daftar putih.

100

AntiScan

boolean

Menentukan apakah perlindungan pemindaian didukung. Nilai yang valid:

true

CustomResponseTemplateMaxCount

integer

Jumlah maksimum template respons kustom yang dapat dikonfigurasi.

20

BaseWafGroupRuleInTemplateMaxCount

integer

Jumlah maksimum aturan perlindungan yang dapat dimuat dalam satu template aturan perlindungan dasar.

100

MajorProtectionTemplateMaxCount

integer

Jumlah maksimum template perlindungan event kritis yang dapat dikonfigurasi.

20

BaseWafGroup

boolean

Menentukan apakah aturan perlindungan dasar didukung. Nilai yang valid:

  • true: Didukung.

  • false: Tidak didukung.

true

Whitelist

boolean

Menentukan apakah daftar putih IP didukung. Nilai yang valid:

  • true: Didukung.

  • false: Tidak didukung.

true

LogService

boolean

Menentukan apakah layanan log didukung. Nilai yang valid:

true

VastIpBlacklistMaxCount

integer

Jumlah maksimum entri daftar hitam IP yang dapat dikonfigurasi oleh satu pengguna.

50000

FreeQps

integer

Nilai QPS gratis yang termasuk dalam paket langganan. Untuk informasi selengkapnya, lihat Edisi WAF 3.0.

Catatan

Parameter ini tidak memiliki arti praktis untuk instans pay-as-you-go.

1000

ExtendQps

integer

Nilai QPS tambahan untuk instans langganan. Untuk informasi selengkapnya, lihat Edisi WAF 3.0.

Catatan

Parameter ini tidak berlaku untuk instans pay-as-you-go.

10000

ElasticQps

integer

Nilai QPS burstable untuk instans langganan dengan penagihan pay-as-you-go untuk kapasitas burstable. Untuk informasi selengkapnya, lihat Edisi WAF 3.0.

Catatan

Parameter ini tidak memiliki arti praktis untuk instans pay-as-you-go.

2000

QpsBillingCap

integer

Ambang batas perlindungan penagihan QPS untuk edisi pay-as-you-go. Untuk informasi selengkapnya, lihat Perlindungan penagihan lalu lintas untuk pay-as-you-go.

Catatan

Parameter ini tidak memiliki arti praktis untuk instans subscription.

2000

HybridCloud

boolean

Menunjukkan apakah Cloud Hibrida diaktifkan.

true

HybridCloudNodeExtend

integer

Jumlah node ekstensi cloud hibrida.

3

Apisec

boolean

Menunjukkan apakah keamanan API diaktifkan.

false

AgenticApisec

boolean

Menunjukkan apakah keamanan API Agentic diaktifkan.

true

ResourceDirectory

boolean

Menunjukkan apakah fitur manajemen multi-akun didukung.

true

RequestId

string

ID permintaan.

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

EndTime

integer

Waktu kedaluwarsa instans. Nilainya merupakan Stempel waktu UNIX. Satuan: milidetik. Format: ms.

4809859200000

InstanceId

string

ID instans WAF.

waf-cn-xxx

InDebt

string

Menunjukkan apakah instans saat ini memiliki pembayaran tertunda. Nilai yang valid:

1

StartTime

integer

Waktu pembelian. Nilainya merupakan Stempel waktu UNIX dalam milidetik.

1668496310000

RegionId

string

Wilayah tempat instans WAF berada. Nilai yang valid:

  • cn-hangzhou: Tiongkok daratan.

  • ap-southeast-1: luar Tiongkok daratan.

cn-hangzhou

PayType

string

Metode penagihan instans. Nilai yang valid:

POSTPAY

Edition

string

Edisi WAF.

default_version

ProcessStatus

string

Status eksekusi instans. Nilai yang valid:

  • commodity_converting: Komoditas sedang dikonversi.

  • commodity_convert_check_failed: Pemeriksaan konversi komoditas gagal.

  • commodity_convert_process_failed: Proses konversi komoditas gagal.

  • order_create_failed: Pembuatan pesanan gagal.

  • order_pending_payment: Pesanan menunggu pembayaran.

order_pending_payment

Contoh

Respons sukses

JSONformat

{
  "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"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.