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

Mengkueri detail port instans layanan cloud yang terhubung ke 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 instans WAF. Catatan Anda dapat memanggil DescribeInstance untuk mengkueri ID instans WAF saat ini.	waf-cn-tl32ast****
ResourceManagerResourceGroupId	string	No	ID kelompok sumber daya Alibaba Cloud.	rg-acfm***q
ResourceInstanceId	string	Yes	ID instans sumber daya.	lb-2zeugkfj81jvo****4tqm
Port	string	No	Port layanan cloud yang terhubung ke WAF.	443
Protocol	string	No	Jenis protokol. Valid values: http : Protokol HTTP. https : Protokol HTTPS.	https
PageNumber	integer	No	Nomor halaman daftar. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman dalam kueri berhalaman. Nilai default: 10.	10
ResourceProduct	string	No	Jenis layanan cloud. Nilai valid: clb4: CLB Lapisan 4. clb7: CLB Lapisan 7. ecs: ECS. nlb: NLB.	clb7
RegionId	string	No	Wilayah tempat instans WAF berada. Nilai valid: cn-hangzhou: Tiongkok Daratan. ap-southeast-1: Luar Tiongkok Daratan.	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 instans layanan cloud yang terhubung ke WAF.
	array<object>	Detail port instans layanan cloud yang terhubung ke WAF.
Protocol	string	Jenis protokol. Nilai valid: http: Protokol HTTP. https: Protokol HTTPS.	https
Port	integer	Port layanan cloud yang terhubung ke WAF.	443
Certificates	array<object>	Daftar sertifikat untuk port layanan cloud yang terhubung ke WAF.
	object	Informasi sertifikat untuk port layanan cloud yang terhubung ke WAF.
CertificateName	string	Nama sertifikat.	cert-name1
CertificateId	string	ID sertifikat yang ditambahkan.	123-cn-hangzhou
AppliedType	string	Jenis sertifikat untuk protokol HTTPS. Nilai yang valid: default: sertifikat default. extension: sertifikat tambahan.	default
XffHeaderMode	integer	Metode yang digunakan WAF untuk memperoleh alamat IP asal klien. Nilai valid: 0: Trafik klien tidak melewati proxy Lapisan 7 apa pun sebelum mencapai WAF. 1: WAF membaca nilai pertama di header X-Forwarded-For (XFF) sebagai alamat IP klien. 2: WAF membaca nilai bidang header kustom yang Anda tentukan sebagai alamat IP klien.	0
XffHeaders	array	Daftar bidang header kustom yang digunakan untuk memperoleh alamat IP klien, dalam format ["header1","header2",……]. Catatan Parameter ini diperlukan hanya jika XffHeaderMode diatur ke 2 (WAF membaca nilai bidang header kustom yang Anda tentukan sebagai alamat IP klien).
	string	Daftar bidang header kustom yang digunakan untuk memperoleh alamat IP klien, dalam format ["header1","header2",……]. Catatan Parameter ini diperlukan hanya jika XffHeaderMode diatur ke 2 (WAF membaca nilai bidang header kustom yang Anda tentukan sebagai alamat IP klien).	header1
LogHeaders	array<object>	Bidang dan nilai tag lalu lintas nama domain, digunakan untuk menandai trafik yang diproses oleh WAF. Catatan Parameter ini dikembalikan hanya jika fitur tag lalu lintas diaktifkan untuk nama domain.
	object	Bidang dan nilai tag lalu lintas nama domain, digunakan untuk menandai trafik yang diproses oleh WAF. Catatan Parameter ini dikembalikan hanya jika fitur tag lalu lintas diaktifkan untuk nama domain.
Key	string	Field header permintaan kustom.	key1
Value	string	Nilai field header permintaan kustom.	value1
Status	integer	Status nama domain. Nilai valid: 1: Port dalam keadaan normal. 2: Port sedang dibuat. 3: Port sedang dimodifikasi. 4: Port sedang dilepaskan.	1
TLSVersion	string	Versi TLS. Nilai valid: tlsv1 tlsv1.1 tlsv1.2	tlsv1
EnableTLSv3	boolean	Apakah TLS 1.3 didukung. Nilai valid: true: TLS 1.3 didukung. false: TLS 1.3 tidak didukung.	true
CipherSuite	integer	Jenis paket sandi. Nilai valid: 1: Semua paket sandi ditambahkan. 2: Paket sandi kuat ditambahkan. 99: Paket sandi kustom ditambahkan.	1
CustomCiphers	array	Paket sandi kustom spesifik yang akan ditambahkan. Parameter ini digunakan hanya jika CipherSuite diatur ke 99.
	string	Paket sandi kustom.	ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384
ReadTimeout	integer	Periode pengatur waktu baca, dalam detik. Nilai valid: 1 hingga 3600.	5
WriteTimeout	integer	Periode pengatur waktu tulis, dalam detik. Nilai valid: 1 hingga 3600.	1
Keepalive	boolean	Apakah koneksi persisten diaktifkan. Nilai valid: true (default): Koneksi persisten diaktifkan. false: Koneksi persisten dinonaktifkan.	true
KeepaliveRequests	integer	Jumlah permintaan yang dapat menggunakan kembali koneksi persisten. Nilai valid: 60 hingga 1000. Catatan Jumlah koneksi persisten yang digunakan kembali setelah koneksi persisten diaktifkan.	1000
KeepaliveTimeout	integer	Periode pengatur waktu idle untuk koneksi persisten. Nilai valid: 10 hingga 3600. Nilai default: 15. Unit: detik. Catatan Waktu idle setelah koneksi persisten yang digunakan kembali dilepaskan.	10
Http2Enabled	boolean	Apakah HTTP/2 diaktifkan. Nilai valid: true: HTTP/2 diaktifkan. false: HTTP/2 dinonaktifkan.	True
XffProto	boolean	Apakah header X-Forward-For-Proto digunakan untuk meneruskan protokol WAF. Nilai valid: true (default): Protokol WAF diteruskan. false: Protokol WAF tidak diteruskan.	true
OwnerUserId	string	UID kepemilikan sumber daya layanan cloud.	123
SubStatus	string	Status pengecualian perlindungan. Nilai valid: InvalidCert: Sertifikat tidak valid. ClientCertOpend: Otentikasi timbal balik diaktifkan. NetworkConfigLost: Konfigurasi jaringan layanan cloud tidak normal.	InvalidCert
SubStatusDetails	array<object>	Alasan spesifik untuk status pengecualian perlindungan. Parameter ini memiliki nilai hanya jika SubStatus adalah InvalidCert.
	object	Alasan spesifik untuk status pengecualian perlindungan. Parameter ini memiliki nilai hanya jika SubStatus adalah InvalidCert.
CertName	string	Nama sertifikat di Certificates Management Service.	test-name
Domain	string	Nama domain yang terikat dengan sertifikat.	test.aliyun.com
CertId	string	ID sertifikat di Certificates Management Service.	123-cn-hangzhou
AppliedType	string	Jenis sertifikat untuk protokol HTTPS. Nilai yang valid: default: sertifikat default. extension: sertifikat tambahan.	default
ProductCertName	string	Nama sertifikat yang disimpan untuk layanan cloud.	test-name
ProductCertId	string	ID sertifikat yang disimpan untuk layanan cloud.	123
CommonName	string	Common name (CN).	test.aliyun.com
ReasonCode	string	Alasan status proteksi abnormal. Nilai yang valid: UserUploadCert: Sertifikat diunggah secara manual. CertNotExistInCertCenter: Sertifikat tidak ada di Certificates Management Service. CertExpired: Sertifikat telah kedaluwarsa. EmptyCertCN: CN sertifikat kosong.	CertNotExistInCertCenter
ExpireTime	integer	Waktu kedaluwarsa sertifikat. Nilai berupa timestamp UNIX. Unit: detik.	1746328456000
CloudResourceId	string	ID sumber daya yang terhubung, dibuat secara otomatis oleh WAF.	i-bp1**************7ey-80-ecs
MaxBodySize	integer	Ukuran badan permintaan maksimum. Nilai 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.	Gagal memverifikasi instans WAF. Periksa apakah ID instans benar.
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.	ID Sumber daya untuk koneksi mode cloud native ke WAF kosong, atau salah satu parameter berikut kosong: nama layanan cloud, port, atau instans layanan cloud.
400	Waf.Pullin.CloudResourceInvalid	CloudResourceId parameter is illegal.	Parameter CloudResourceId tidak valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.