Gunakan DescribeDomains API untuk Mendapatkan Semua Domain yang Dilindungi WAF - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Mengkueri nama domain yang ditambahkan ke Web Application Firewall (WAF).

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:DescribeDomains

get

*全部资源

*

None

yundun-waf:DescribeDomains

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans WAF. Catatan Panggil DescribeInstance untuk Tampilan ID instans WAF saat ini.	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	No	ID kelompok sumber daya Alibaba Cloud.	rg-acfm***q
Domain	string	No	Nama domain yang ditambahkan ke WAF.	www.aliyundoc.com
Backend	string	No	Alamat IP server asal atau nama domain back-to-origin. Anda hanya dapat menentukan salah satu dari opsi ini.	1.1.XX.XX
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10.	10
DomainId	string	No	ID nama domain.	www.aliyundoc.com-waf
RegionId	string	No	Wilayah tempat instans WAF berada. Nilai valid: cn-hangzhou: Tiongkok daratan. ap-southeast-1: di luar Tiongkok daratan.	cn-hangzhou
Tag	array<object>	No	Tag sumber daya. Anda dapat menentukan hingga 20 tag.
	object	No	The tags of the resource.
Key	string	No	The tag key.	TagKey1
Value	string	No	The tag value.	TagValue1

Elemen respons

Element	Type	Description	Example
	object	The list of added domain names.
RequestId	string	The request ID.	ABF68BB3-2C48-5FA4-9750-D5FE55700E36
TotalCount	integer	The total number of domain name configurations returned.	146
Domains	array<object>	The list of domain names.
	array<object>	The CNAME connection details.
Domain	string	The domain name that is added to WAF.	www.aliyundoc.com
Status	integer	The status of the domain name. Valid values: 1: The domain name is in a normal state. 2: The domain name is being created. 3: The domain name is being modified. 4: The domain name is being released. 5: Forwarding is disabled for the domain name.	1
Cname	string	The canonical name (CNAME) that is assigned to the domain name by WAF.	xxxxxcvdaf.****.com
ListenPorts	object	The listener configuration.
Http	array	A list of HTTP listener ports.
	integer	An HTTP listener port.	80
Https	array	A list of HTTPS listener ports.
	integer	An HTTPS listener port.	443
Backeds	object	The back-to-origin configuration.
Http	array<object>	A list of origin addresses for the HTTP protocol.
	object	An origin address for the HTTP protocol.
Backend	string	The origin address for the HTTP protocol.	1.1.XX.XX
Https	array<object>	A list of origin addresses for the HTTPS protocol.
	object	An origin address for the HTTPS protocol.
Backend	string	The origin address for the HTTPS protocol.	1.1.XX.XX
ResourceManagerResourceGroupId	string	The ID of the Alibaba Cloud resource group.	rg-acfmvtc5z52****
DomainId	string	The ID of the domain name.	www.aliyundoc.com-waf

Contoh

Respons sukses

JSONformat

{
  "RequestId": "ABF68BB3-2C48-5FA4-9750-D5FE55700E36",
  "TotalCount": 146,
  "Domains": [
    {
      "Domain": "www.aliyundoc.com",
      "Status": 1,
      "Cname": "xxxxxcvdaf.****.com",
      "ListenPorts": {
        "Http": [
          80
        ],
        "Https": [
          443
        ]
      },
      "Backeds": {
        "Http": [
          {
            "Backend": "1.1.XX.XX"
          }
        ],
        "Https": [
          {
            "Backend": "1.1.XX.XX"
          }
        ]
      },
      "ResourceManagerResourceGroupId": "rg-acfmvtc5z52****",
      "DomainId": "www.aliyundoc.com-waf"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.