CreateIngress - Serverless App Engine - Alibaba Cloud Documentation Center

Membuat aturan routing.

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

sae:CreateIngress

create

*全部资源

*

None

Sintaks permintaan

POST /pop/v1/sam/ingress/Ingress HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	ID namespace tempat aplikasi berada. Aplikasi lintas namespace tidak didukung.	cn-beijing:sae-test
Description	string	No	Nama aturan routing.	ingress-for-sae-test
SlbId	string	No	ID Instance SLB yang terkait dengan aturan routing. Catatan SLB mencakup Instans Classic Load Balancer (CLB) dan Application Load Balancer (ALB).	lb-uf6hucc7inlqrtcq5****
ListenerPort	integer	Yes	Port Pendengar untuk Instance SLB. Port ini harus tersedia.	80
CertId	string	No	ID Sertifikat CLB. Jika `LoadBalanceType` diatur ke `clb`, gunakan parameter ini untuk mengonfigurasi Sertifikat Pendengar HTTPS. Untuk informasi selengkapnya tentang cara menggunakan ID Sertifikat SSL untuk CLB, lihat Kelola Sertifikat (CLB).	188077086902**_176993d_181437_108724**
CertIds	string	No	ID Sertifikat ALB. Jika `LoadBalanceType` diatur ke `alb`, gunakan parameter ini untuk mengonfigurasi beberapa Sertifikat untuk Pendengar HTTPS. Pisahkan beberapa ID Sertifikat dengan koma (,). Dapatkan ID Sertifikat SSL untuk Instans ALB dari layanan Sertifikat Digital. Misalnya, jika Anda mengonfigurasi `756*-ap-southeast-1`, `756*` adalah ID Sertifikat yang diperoleh dari halaman Produk dan `-ap-southeast-1` adalah sufiks tetap. Untuk informasi selengkapnya, lihat Kelola Sertifikat (ALB).	87*35-cn-hangzhou,812*3-cn-hangzhou
DefaultRule	string	Yes	Aturan pengalihan default. Permintaan yang tidak cocok dengan aturan pengalihan apa pun di parameter `Rules` dialihkan ke aplikasi yang ditentukan dalam aturan ini. Nilainya adalah string JSON dengan parameter berikut: `appId`: ID aplikasi. `containerPort`: Port instans aplikasi. Catatan Aturan ini berfungsi sebagai penangkap semua untuk Trafik yang tidak ditangani oleh aturan pengalihan spesifik lainnya.	{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080}
Rules	string	Yes	Aturan pengalihan. Aturan ini entri rute Trafik ke aplikasi tertentu berdasarkan Nama domain dan path. Nilainya adalah string JSON. Setiap aturan berisi parameter berikut: `appId`: ID aplikasi. `containerPort`: Port instans aplikasi. `domain`: Nama domain. `path`: Path permintaan. `backendProtocol`: Protokol yang digunakan oleh server backend. Nilai valid: `http`, `https`, dan `grpc`. Nilai default: `http`. `rewritePath`: Path yang ditulis ulang. Catatan Hanya ALB yang mendukung penulisan ulang path (`RewritePath`). CLB tidak mendukung fitur ini.	[{"appId":"395b60e4-0550-458d-9c54-a265d036**","containerPort":8080,"domain":"www.sae.site","path":"/path1"},{"appId":"666403ce-d25b-47cf-87fe-497565d2*","containerPort":8080,"domain":"sae.site","path":"/sys/(.)/(.*)/aaa","backendProtocol":"http"}]
LoadBalanceType	string	No	Tipe Instance SLB. Parameter ini tidak dapat diubah setelah aturan routing dibuat. Nilai valid: `clb`: Classic Load Balancer (CLB), sebelumnya dikenal sebagai SLB. `alb`: Application Load Balancer (ALB).	clb
ListenerProtocol	string	No	Protokol pengalihan permintaan. Nilai valid: `HTTP`: untuk aplikasi yang tidak memerlukan Enkripsi. `HTTPS`: untuk aplikasi yang memerlukan transmisi data terenkripsi.	HTTP
SecurityPolicyId	string	No	ID Instans kebijakan keamanan.	sp-bp1bpn0kn9****
RequestTimeout	integer	No	Waktu tunggu permintaan, dalam detik. Nilai valid: 1 hingga 180. Jika server backend tidak merespons dalam periode waktu tunggu, load balancer berhenti menunggu dan mengembalikan kode kesalahan HTTP 504 ke Klien.	3
IdleTimeout	integer	No	Waktu tunggu idle koneksi, dalam detik. Nilai valid: 1 hingga 60. Jika tidak ada permintaan yang diterima dalam periode waktu tunggu, load balancer menutup koneksi sementara. Koneksi akan dibangun kembali ketika permintaan berikutnya diterima.	15
EnableXForwardedFor	boolean	No	Apakah akan menggunakan Header `X-Forwarded-For` untuk mengambil alamat IP Klien.	true
EnableXForwardedForClientSrcPort	boolean	No	Apakah akan menggunakan Header `X-Forwarded-Port` untuk mengambil port sumber Klien.	true
EnableXForwardedForProto	boolean	No	Apakah akan menggunakan Header `X-Forwarded-Proto` untuk mengambil protokol Pendengar dari Instans load balancer.	true
EnableXForwardedForSlbId	boolean	No	Apakah akan menggunakan Header `SLB-ID` untuk mengambil ID Instans load balancer.	true
EnableXForwardedForSlbPort	boolean	No	Apakah akan menggunakan Header `X-Forwarded-Port` untuk mengambil Port Pendengar dari Instans load balancer.	true
AddressType	string	No	Tipe alamat. Nilai valid: `Internet`: Alamat publik. `Intranet`: Alamat privat.	Internet
LoadBalancerEdition	string	No	Edisi Instans ALB. Edisi yang berbeda memiliki fitur dan kebijakan penagihan yang berbeda. Nilai valid: `Standard`: Jenis Penyimpanan Standar. `StandardWithWaf`: Edisi yang ditingkatkan dengan WAF.	Standard
ZoneMappings	string	No	String JSON yang berisi pemetaan antara zona ketersediaan dan VSwitch. Jika Wilayah saat ini mendukung dua atau lebih zona ketersediaan, tentukan setidaknya dua. ZoneMapping terdiri dari parameter berikut: `VSwitchId`: String yang menentukan ID VSwitch yang sesuai dengan zona ketersediaan. Setiap zona ketersediaan hanya dapat memiliki satu VSwitch dan satu subnet. `ZoneId`: String yang menentukan ID zona ketersediaan untuk Instans load balancer.	[{"VSwitchId":"vsw-wz9klui6icc08p6****","ZoneId":"cn-shenzhen-c"},{"VSwitchId":"vsw-wz9frrmoeuki2wp****","ZoneId":"cn-shenzhen-e"}]
CorsConfig	string	No	Konfigurasi Cross-Origin Resource Sharing (CORS).	{"Enable":"true"}
EnableGzip	boolean	No	Apakah akan mengaktifkan Gzip untuk kompresi data.	true

Elemen respons

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. If the request is successful, success is returned. If the request fails, an error code is returned.	success
TraceId	string	The trace ID that is used to query the details of the request.	0a98a02315955564772843261e****
Data	object	The returned results.
IngressId	integer	The ID of the routing rule.	87
ErrorCode	string	The error code. This parameter is not returned if the request is successful. This parameter is returned if the request fails. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code. Valid values: 2xx: The request is successful. 3xx: The request is redirected. 4xx: A request error occurs. 5xx: A server error occurs.	200
Success	boolean	Indicates whether the routing rule was created. Valid values: true: The routing rule was created. false: The routing rule failed to be created.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "IngressId": 87
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	Slb.NotFound	The SLB instance does not exist: slbId [%s]
400	Exceed.IngressRule	The number of Ingress related rules must be less than or equal to 40.
400	SlbListenerPort.NotAvailable	The SLB listening port is unavailable: slbId [%s], port [%s]
400	SSLCert.NotFound	The specified SSL certificate cannot be found.
404	InvalidResponse.Api	The response of API %s is empty.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.