Memperbarui properti aturan pengalihan, seperti kondisi, aksi, dan nama aturan tersebut.
Deskripsi operasi
UpdateRuleAttribute adalah operasi asinkron. Setelah mengirim permintaan, sistem akan mengembalikan ID permintaan dan menjalankan tugas di latar belakang. Anda dapat memanggil operasi ListRules untuk mengecek status aturan pengalihan.
Jika aturan pengalihan berada dalam status Configuring, propertinya sedang diperbarui.
Jika aturan pengalihan berada dalam status Available, propertinya telah diperbarui.
Jumlah maksimum kondisi (RuleConditions) dan aksi (RuleActions) yang dapat ditambahkan ke aturan pengalihan adalah sebagai berikut:
Kondisi: 5 untuk Edisi Dasar, 10 untuk Edisi Standar, dan 10 untuk Edisi dengan WAF.
Aksi: 3 untuk Edisi Dasar, 5 untuk Edisi Standar, dan 5 untuk Edisi dengan WAF.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
alb:UpdateRuleAttribute |
update |
*LoadBalancer
*ServerGroup
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RuleId |
string |
Yes |
ID aturan pengalihan. |
rule-4dp5i6ea**** |
| ClientToken |
string |
No |
Token klien yang digunakan untuk memastikan idempotensi permintaan. Buat nilai parameter dari klien Anda untuk memastikan nilainya unik di antara permintaan yang berbeda. Token klien hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId mungkin berbeda untuk setiap permintaan API. |
5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
| DryRun |
boolean |
No |
Menentukan apakah akan melakukan dry run. Nilai yang valid:
|
false |
| RuleConditions |
array<object> |
No |
Kondisi aturan pengalihan. |
|
|
array<object> |
No |
Kondisi aturan pengalihan. |
||
| CookieConfig |
object |
No |
Konfigurasi cookie. |
|
| Values |
array<object> |
No |
Cookie. |
|
|
object |
No |
Konfigurasi cookie. |
||
| Key |
string |
No |
Kunci cookie. Kunci harus terdiri dari 1 hingga 100 karakter dan dapat berisi huruf kecil, karakter yang dapat dicetak, tanda bintang (*), dan tanda tanya (?). Kunci tidak boleh berisi spasi atau karakter khusus berikut: |
test |
| Value |
string |
No |
Nilai cookie. Nilai harus terdiri dari 1 hingga 128 karakter dan dapat berisi huruf kecil, karakter yang dapat dicetak, tanda bintang (*), dan tanda tanya (?). Nilai tidak boleh berisi spasi atau karakter khusus berikut: |
test |
| HeaderConfig |
object |
No |
Konfigurasi header permintaan. |
|
| Key |
string |
No |
Kunci header permintaan. Kunci harus terdiri dari 1 hingga 40 karakter dan dapat berisi huruf, angka, tanda hubung (-), dan garis bawah (_). Cookie dan Host tidak didukung. |
Port |
| Values |
array |
No |
Nilai header permintaan. |
|
|
string |
No |
Nilai header permintaan. Nilai-nilai untuk kunci header permintaan yang sama tidak boleh identik dalam satu kondisi aturan pengalihan. Konvensi penamaan:
|
5006 |
|
| HostConfig |
object |
No |
Konfigurasi host. |
|
| Values |
array |
No |
Daftar hostname. |
|
|
string |
No |
Hostname. Konvensi penamaan:
|
www.example.com |
|
| MethodConfig |
object |
No |
Konfigurasi metode permintaan. |
|
| Values |
array |
No |
Daftar metode permintaan. |
|
|
string |
No |
Metode permintaan. Nilai yang valid: HEAD, GET, POST, OPTIONS, PUT, PATCH, dan DELETE. |
PUT |
|
| PathConfig |
object |
No |
Konfigurasi path. |
|
| Values |
array |
No |
Daftar path pengalihan. |
|
|
string |
No |
Path pengalihan. Konvensi penamaan:
|
/test |
|
| QueryStringConfig |
object |
No |
Konfigurasi string kueri. |
|
| Values |
array<object> |
No |
Daftar string kueri. Anda dapat menambahkan hingga 20 string kueri. |
|
|
object |
No |
Struktur string kueri. |
||
| Key |
string |
No |
Kunci string kueri. Kunci harus terdiri dari 1 hingga 100 karakter dan dapat berisi huruf kecil, karakter yang dapat dicetak, tanda bintang (*), dan tanda tanya (?). Kunci tidak boleh berisi spasi atau karakter khusus berikut: |
test |
| Value |
string |
No |
Nilai string kueri. Nilai harus terdiri dari 1 hingga 128 karakter dan dapat berisi huruf kecil, karakter yang dapat dicetak, tanda bintang (*), dan tanda tanya (?). Nilai tidak boleh berisi spasi atau karakter khusus berikut: |
test |
| Type |
string |
No |
Jenis kondisi aturan pengalihan. Anda dapat menambahkan hingga tujuh jenis kondisi aturan pengalihan. Nilai yang valid:
|
Host |
| ResponseStatusCodeConfig |
object |
No |
Konfigurasi kode status HTTP. |
|
| Values |
array |
No |
Daftar kode status HTTP. |
|
|
string |
No |
Kode status HTTP. |
301 |
|
| ResponseHeaderConfig |
object |
No |
Konfigurasi kondisi header. |
|
| Key |
string |
No |
Kunci header.
|
test |
| Values |
array |
No |
Nilai header. |
|
|
string |
No |
Nilai header.
|
50006 |
|
| SourceIpConfig |
object |
No |
Mencocokkan lalu lintas layanan berdasarkan alamat IP sumber. Anda dapat menambahkan hingga lima alamat IP sumber. |
|
| Values |
array |
No |
Satu atau beberapa alamat IP atau Blok CIDR. |
|
|
string |
No |
Satu atau beberapa alamat IP atau Blok CIDR. |
192.168.0.0/32 |
|
| RuleActions |
array<object> |
No |
Aksi aturan pengalihan. |
|
|
array<object> |
No |
Aksi aturan pengalihan. |
||
| FixedResponseConfig |
object |
No |
Konfigurasi respons tetap. |
|
| Content |
string |
No |
Respons tetap. Respons dapat memiliki panjang hingga 1 KB dan hanya boleh berisi karakter ASCII. |
dssacav |
| ContentType |
string |
No |
Format respons tetap. Nilai yang valid: text/plain, text/css, text/html, application/javascript, dan application/json. |
text/plain |
| HttpCode |
string |
No |
Kode status HTTP. Nilai harus berupa string yang terdiri dari angka. Nilai yang valid: 2xx, 4xx, dan 5xx. x adalah angka. |
200 |
| ForwardGroupConfig |
object |
No |
Konfigurasi kelompok server. |
|
| ServerGroupTuples |
array<object> |
No |
Daftar kelompok server tujuan. |
|
|
object |
No |
Kelompok server tujuan. |
||
| ServerGroupId |
string |
No |
ID kelompok server tujuan. |
sg--atstuj3rtoptyui**** |
| Weight |
integer |
No |
Bobot. Nilai yang lebih besar menunjukkan bobot yang lebih tinggi. Kelompok server dengan bobot lebih tinggi menerima lebih banyak permintaan. Nilai yang valid: 0 hingga 100.
|
30 |
| ServerGroupStickySession |
object |
No |
Persistensi sesi untuk kelompok server. |
|
| Enabled |
boolean |
No |
Menentukan apakah persistensi sesi diaktifkan. Nilai yang valid:
|
false |
| Timeout |
integer |
No |
Periode timeout. Satuan: detik. Nilai yang valid: 1 hingga 86400. |
2 |
| InsertHeaderConfig |
object |
No |
Konfigurasi untuk menyisipkan header permintaan. |
|
| CoverEnabled |
boolean |
No |
Menentukan apakah akan menimpa nilai header permintaan yang memiliki kunci yang sama. Nilai yang valid:
|
false |
| Key |
string |
No |
Kunci header permintaan yang akan disisipkan. Kunci harus terdiri dari 1 hingga 40 karakter, dan dapat berisi huruf kecil, angka, garis bawah (_), dan tanda hubung (-). Kunci dalam InsertHeaderConfig tidak boleh sama dengan kunci dalam RemoveHeaderConfig. Catatan Kunci header berikut tidak didukung: |
key |
| Value |
string |
No |
Nilai header yang akan disisipkan.
|
UserDefined |
| ValueType |
string |
No |
Jenis nilai header. Nilai yang valid:
|
UserDefined |
| Order |
integer |
No |
Urutan aksi. Nilai yang valid: 1 hingga 50000. Nilai yang lebih kecil menunjukkan prioritas yang lebih tinggi. Nilai harus unik dan tidak boleh kosong. Anda dapat menentukan hingga 20 urutan untuk aksi. |
1 |
| RedirectConfig |
object |
No |
Konfigurasi pengalihan. Anda dapat menambahkan hingga 20 pengalihan. |
|
| Host |
string |
No |
Hostname tujuan. Nilai yang valid:
|
www.example.com |
| HttpCode |
string |
No |
Metode pengalihan. Nilai yang valid: 301, 302, 303, 307, dan 308. |
301 |
| Path |
string |
No |
Path tujuan. Nilai yang valid:
|
/test |
| Port |
string |
No |
Port tujuan. Nilai yang valid:
|
10 |
| Protocol |
string |
No |
Protokol tujuan. Nilai yang valid:
Catatan Pendengar HTTPS hanya mendukung HTTPS. |
HTTP |
| Query |
string |
No |
String kueri tujuan. Nilai yang valid:
|
quert |
| RewriteConfig |
object |
No |
Konfigurasi rewrite. |
|
| Host |
string |
No |
Hostname tujuan untuk pengalihan internal. Nilai yang valid:
|
www.example.com |
| Path |
string |
No |
Path tujuan. Nilai yang valid:
|
/tsdf |
| Query |
string |
No |
String kueri tujuan untuk pengalihan internal. Nilai yang valid:
|
quedsa |
| Type |
string |
No |
Jenis aksi. Anda dapat menambahkan hingga 11 jenis aksi. Nilai yang valid:
Catatan Aturan pengalihan harus berisi aksi ForwardGroup, Redirect, atau FixedResponse. Jika Anda ingin menggunakan aksi ini bersama jenis aksi lain, pastikan aksi ini dieksekusi terakhir. |
ForwardGroup |
| TrafficLimitConfig |
object |
No |
Konfigurasi pembatasan kecepatan. |
|
| QPS |
integer |
No |
Jumlah permintaan per detik (QPS). Nilai yang valid: 1 hingga 1000000. |
100 |
| PerIpQps |
integer |
No |
QPS untuk satu alamat IP. Nilai yang valid: 1 hingga 1000000. Catatan Jika Anda menentukan QPS dan PerIpQps, nilai PerIpQps harus lebih kecil dari nilai QPS. |
80 |
| TrafficMirrorConfig |
object |
No |
Konfigurasi pencerminan lalu lintas. |
|
| TargetType |
string |
No |
Jenis tujuan tempat lalu lintas dicerminkan. Nilai yang valid:
|
ForwardGroupMirror |
| MirrorGroupConfig |
object |
No |
Kelompok server tempat lalu lintas dicerminkan. |
|
| ServerGroupTuples |
array<object> |
No |
Kelompok server tempat lalu lintas dicerminkan. |
|
|
object |
No |
Kelompok server tempat lalu lintas dicerminkan. |
||
| ServerGroupId |
string |
No |
ID kelompok server. |
srg-00mkgijak0w4qgz9**** |
| RemoveHeaderConfig |
object |
No |
Konfigurasi untuk menghapus header permintaan. |
|
| Key |
string |
No |
Kunci header permintaan yang akan dihapus. Kunci harus terdiri dari 1 hingga 40 karakter, dan dapat berisi huruf kecil, angka, garis bawah (_), dan tanda hubung (-). Kunci tidak boleh digunakan lebih dari sekali dalam RemoveHeaderConfig.
|
test |
| CorsConfig |
object |
No |
Konfigurasi CORS. |
|
| AllowOrigin |
array |
No |
Daftar origin yang diizinkan. Anda hanya dapat menentukan satu
|
|
|
string |
No |
Origin yang diizinkan. |
http://test.com |
|
| AllowMethods |
array |
No |
Metode HTTP yang diizinkan untuk permintaan lintas asal. |
|
|
string |
No |
Metode HTTP yang diizinkan untuk permintaan lintas asal. Nilai yang valid:
|
GET |
|
| AllowHeaders |
array |
No |
Daftar header yang diizinkan untuk permintaan lintas asal. |
|
|
string |
No |
Daftar header yang diizinkan untuk permintaan lintas asal. Anda dapat menentukan |
test_123 |
|
| ExposeHeaders |
array |
No |
Daftar header yang dapat diekspos ke klien. |
|
|
string |
No |
Daftar header yang dapat diekspos ke klien. Anda dapat menentukan |
test_123 |
|
| AllowCredentials |
string |
No |
Menentukan apakah kredensial diizinkan. Nilai yang valid:
|
on |
| MaxAge |
integer |
No |
Waktu cache maksimum untuk permintaan preflight di browser. Satuan: detik. Nilai yang valid: -1 hingga 172800. |
1000 |
| RuleName |
string |
No |
Nama aturan pengalihan. Nama harus terdiri dari 2 hingga 128 karakter, dan dapat berisi huruf, angka, titik (.), garis bawah (_), dan tanda hubung (-). Nama harus diawali dengan huruf atau karakter Tionghoa. |
rule-instance-test |
| Priority |
integer |
No |
Prioritas aturan. Nilai yang valid: 1 hingga 10000. Nilai yang lebih kecil menunjukkan prioritas yang lebih tinggi. Catatan Prioritas aturan yang dimiliki oleh pendengar yang sama harus unik. |
10 |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Memperbarui atribut aturan pengalihan yang ditentukan. |
||
| JobId |
string |
ID tugas asinkron. |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
| RequestId |
string |
ID permintaan. |
365F5378-41F6-4AE4-92F8-7FF34B540710 |
Contoh
Respons sukses
JSONformat
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F5378-41F6-4AE4-92F8-7FF34B540710"
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | IncorrectStatus.Rule | The status of %s [%s] is incorrect. | |
| 400 | OperationDenied.IpGroupCanNotUsedForMirrorAction | The operation is not allowed because of %s. | The operation is not allowed because of %s. |
| 400 | OperationDenied.SameGroupForForwardAndMirrorAction | The operation is not allowed because of %s. | The operation is not allowed because of %s. |
| 400 | OperationDenied.GRPCServerGroup | The operation is not allowed because of %s. | |
| 400 | Conflict.Priority | There is already %s having the same configuration with %s. | |
| 400 | ResourceQuotaExceeded.ServerGroupAttachedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | ResourceQuotaExceeded.LoadBalancerServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | ResourceQuotaExceeded.ServerAddedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | QuotaExceeded.RuleWildcardsNum | The quota of %s is exceeded, usage %s/%s. | The quota of %s is exceeded, usage %s/%s. |
| 400 | QuotaExceeded.RuleMatchEvaluationsNum | The quota of %s is exceeded, usage %s/%s. | |
| 400 | QuotaExceeded.RuleActionsNum | The quota of %s is exceeded, usage %s/%s. | The quota of %s is exceeded. Usage: %s/%s. |
| 400 | Mismatch.Protocol | The %s is mismatched for %s and %s. | The %s is mismatched for %s and %s. |
| 400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | The %s is mismatched for %s and %s. |
| 400 | OperationDenied.RewriteMissingForwardGroup | The operation is not allowed because of RewriteMissingForwardGroup. | The operation is not allowed because rewrite is missing the forward group. |
| 400 | ResourceInConfiguring.Listener | The specified listener is being configured, please try again later. | |
| 400 | OperationDenied.ProtocolMustSameForForwardGroupAction | The operation is not allowed because of ProtocolMustSameForForwardGroupAction. | |
| 403 | Forbidden.ServerGroup | Authentication has failed for ServerGroup. | |
| 403 | Forbidden.LoadBalancer | Authentication is failed for %s. | Authentication is failed for %s. |
| 404 | ResourceNotFound.Rule | The specified resource %s is not found. | The specified resource %s is not found. |
| 404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.