Referensi API DescribeCloudResourceAccessPortDetails - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Mengambil detail port instance layanan cloud yang terdaftar di 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:DescribeCloudResourceAccessPortDetails

get

*All Resource

*

acs:ResourceGroupId

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instance WAF. Catatan Panggil operasi DescribeInstance untuk meng-query ID instance WAF.	waf-cn-tl32ast****
ResourceManagerResourceGroupId	string	No	ID grup sumber daya.	rg-acfm***q
ResourceInstanceId	string	Yes	ID instance sumber daya.	lb-2zeugkfj81jvo****4tqm
Port	string	No	Port layanan cloud yang ditambahkan ke WAF.	443
Protocol	string	No	Protokol. Nilai yang valid: http: HTTP. https: HTTPS.	https
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10.	10
ResourceProduct	string	No	Jenis layanan cloud. Nilai yang valid: clb4: Classic Load Balancer (CLB) Layer 4. clb7: CLB Layer 7. ecs: Elastic Compute Service (ECS). nlb: Network Load Balancer (NLB).	clb7
RegionId	string	No	Region tempat instance WAF berada. Nilai yang valid: cn-hangzhou: daratan Tiongkok. ap-southeast-1: di luar daratan Tiongkok.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	2EFCFE18-78F8-5079-B312-07***48B
TotalCount	integer	Jumlah total entri yang dikembalikan.	10
AccessPortDetails	array<object>	Detail port untuk instance layanan cloud yang ditambahkan ke WAF.
	array<object>	Detail port untuk instance layanan cloud yang ditambahkan ke WAF.
Protocol	string	Protokol. Nilai yang valid: http: HTTP. https: HTTPS.	https
Port	integer	Port layanan cloud yang ditambahkan ke WAF.	443
Certificates	array<object>	Daftar sertifikat untuk port instance layanan cloud.
	object	Informasi tentang sertifikat untuk port instance layanan cloud.
CertificateName	string	The name of the certificate.	cert-name1
CertificateId	string	The ID of the added certificate.	123-cn-hangzhou
AppliedType	string	The type of the certificate for the HTTPS protocol. Valid values: default: default certificate. extension: extension certificate.	default
XffHeaderMode	integer	Mode yang digunakan WAF untuk mendapatkan alamat IP asli klien. Nilai yang valid: 0: WAF adalah proxy Layer 7 pertama sebelum trafik klien diteruskan ke server asal. 1: WAF membaca alamat IP pertama dari header X-Forwarded-For (XFF) sebagai alamat IP klien. 2: WAF membaca nilai header kustom sebagai alamat IP klien.	0
XffHeaders	array	Field header kustom yang digunakan untuk mendapatkan alamat IP klien. Nilainya adalah string dalam format `["header1","header2",...]`. Catatan Parameter ini hanya dikembalikan ketika XffHeaderMode diatur ke 2.
	string	Field header kustom yang digunakan untuk mendapatkan alamat IP klien. Nilainya adalah string dalam format `["header1","header2",...]`. Catatan Parameter ini hanya dikembalikan ketika XffHeaderMode diatur ke 2.	header1
LogHeaders	array<object>	Pasangan kunci-nilai yang digunakan untuk menandai trafik yang diproses oleh WAF. Catatan Parameter ini hanya dikembalikan ketika fitur penandaan trafik diaktifkan untuk nama domain.
	object	Pasangan kunci-nilai yang digunakan untuk menandai trafik yang diproses oleh WAF. Catatan Parameter ini hanya dikembalikan ketika fitur penandaan trafik diaktifkan untuk nama domain.
Key	string	The custom request header field.	key1
Value	string	The value of the custom request header field.	value1
Status	integer	Status nama domain. Nilai yang valid: 1: Port berada dalam status Normal. 2: Port sedang dibuat. 3: Port sedang diubah. 4: Port sedang dilepaskan.	1
TLSVersion	string	Versi protokol Transport Layer Security (TLS). Nilai yang valid: tlsv1 tlsv1.1 tlsv1.2	tlsv1
EnableTLSv3	boolean	Menunjukkan apakah TLS 1.3 didukung. Nilai yang valid: true: TLS 1.3 didukung. false: TLS 1.3 tidak didukung.	true
CipherSuite	integer	Jenis cipher suite. Nilai yang valid: 1: semua cipher suite. 2: cipher suite kuat. 99: cipher suite kustom.	1
CustomCiphers	array	Cipher suite kustom. Parameter ini hanya dikembalikan ketika CipherSuite diatur ke 99.
	string	Cipher suite kustom.	ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384
ReadTimeout	integer	Periode batas waktu baca. Unit: detik. Nilai yang valid: 1 hingga 3600.	5
WriteTimeout	integer	Periode batas waktu tulis. Unit: detik. Nilai yang valid: 1 hingga 3600.	1
Keepalive	boolean	Menunjukkan apakah akan mengaktifkan koneksi persisten. Nilai yang valid: true: Mengaktifkan koneksi persisten. Ini adalah nilai default. false: Menonaktifkan koneksi persisten.	true
KeepaliveRequests	integer	Jumlah permintaan yang dapat digunakan kembali dalam koneksi persisten. Nilai yang valid: 60 hingga 1000. Catatan Parameter ini menentukan jumlah permintaan yang dapat digunakan kembali setelah koneksi persisten dibuat.	1000
KeepaliveTimeout	integer	Periode batas waktu untuk koneksi persisten yang menganggur. Nilai yang valid: 10 hingga 3600. Nilai default: 15. Unit: detik. Catatan Parameter ini menentukan periode waktu setelah koneksi persisten yang menganggur dilepaskan.	10
Http2Enabled	boolean	Menunjukkan apakah HTTP/2 diaktifkan. Nilai yang valid: true: HTTP/2 diaktifkan. false: HTTP/2 tidak diaktifkan.	True
XffProto	boolean	Menunjukkan apakah akan menggunakan header X-Forwarded-For-Proto untuk mengidentifikasi protokol yang digunakan oleh WAF. Nilai yang valid: true: Mengidentifikasi protokol yang digunakan oleh WAF. Ini adalah nilai default. false: Tidak mengidentifikasi protokol yang digunakan oleh WAF.	true
OwnerUserId	string	ID akun Alibaba Cloud tempat layanan cloud berada.	123
SubStatus	string	Status proteksi abnormal. Nilai yang valid: InvalidCert: Sertifikat tidak valid. ClientCertOpend: Otentikasi timbal balik diaktifkan. NetworkConfigLost: Konfigurasi jaringan layanan cloud abnormal.	InvalidCert
SubStatusDetails	array<object>	Detail status proteksi abnormal. Parameter ini hanya dikembalikan ketika SubStatus diatur ke InvalidCert.
	object	Detail status proteksi abnormal. Parameter ini hanya dikembalikan ketika SubStatus diatur ke InvalidCert.
CertName	string	The name of the certificate in SSL Certificates Service.	test-name
Domain	string	The domain name that is bound to the certificate.	test.aliyun.com
CertId	string	The ID of the certificate in SSL Certificates Service.	123-cn-hangzhou
AppliedType	string	The type of the certificate for the HTTPS protocol. Valid values: default: default certificate. extension: extension certificate.	default
ProductCertName	string	The name of the certificate that is saved for the cloud service.	test-name
ProductCertId	string	The ID of the certificate that is saved for the cloud service.	123
CommonName	string	The common name (CN).	test.aliyun.com
ReasonCode	string	The reason for the abnormal protection status. Valid values: UserUploadCert: The certificate is manually uploaded. CertNotExistInCertCenter: The certificate does not exist in SSL Certificates Service. CertExpired: The certificate has expired. EmptyCertCN: The CN of the certificate is empty.	CertNotExistInCertCenter
ExpireTime	integer	The expiration time of the certificate. The value is a UNIX timestamp. Unit: seconds.	1746328456000
CloudResourceId	string	ID sumber daya yang ditambahkan ke WAF. ID dihasilkan secara otomatis oleh WAF.	i-bp1**************7ey-80-ecs
MaxBodySize	integer	Ukuran maksimum body permintaan. Nilai yang valid: 2 hingga 10. Nilai default: 2. Unit: GB.	2

Contoh

Respons sukses

JSONformat

{
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "TotalCount": 10,
  "AccessPortDetails": [
    {
      "Protocol": "https",
      "Port": 443,
      "Certificates": [
        {
          "CertificateName": "cert-name1",
          "CertificateId": "123-cn-hangzhou",
          "AppliedType": "default"
        }
      ],
      "XffHeaderMode": 0,
      "XffHeaders": [
        "header1"
      ],
      "LogHeaders": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "Status": 1,
      "TLSVersion": "tlsv1",
      "EnableTLSv3": true,
      "CipherSuite": 1,
      "CustomCiphers": [
        "ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384"
      ],
      "ReadTimeout": 5,
      "WriteTimeout": 1,
      "Keepalive": true,
      "KeepaliveRequests": 1000,
      "KeepaliveTimeout": 10,
      "Http2Enabled": true,
      "XffProto": true,
      "OwnerUserId": "123",
      "SubStatus": "InvalidCert",
      "SubStatusDetails": [
        {
          "CertName": "test-name",
          "Domain": "test.aliyun.com",
          "CertId": "123-cn-hangzhou",
          "AppliedType": "default",
          "ProductCertName": "test-name",
          "ProductCertId": "123",
          "CommonName": "test.aliyun.com",
          "ReasonCode": "CertNotExistInCertCenter",
          "ExpireTime": 1746328456000
        }
      ],
      "CloudResourceId": "i-bp1**************7ey-80-ecs",
      "MaxBodySize": 2
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Waf.Instance.ValidFaild	WAF instance check failed. Check whether the instance ID is correct.	WAF instance check failed. Check whether the instance ID is correct.
400	Waf.Pullin.CloudProductParamEmpty	The resource Id of the cloud product accessing WAF is null or null values exist in the three input parameters of the cloud product name, port, and cloud product instance.	The resource Id of the cloud product accessing WAF is null or null values exist in the three input parameters of the cloud product name, port, and cloud product instance.
400	Waf.Pullin.CloudResourceInvalid	CloudResourceId parameter is illegal.	CloudResourceId parameter is illegal

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.