Met à jour les attributs d'une règle de transfert, tels que les conditions, les actions et le nom.
Description de l'opération
UpdateRuleAttribute est une opération asynchrone. Après l'envoi d'une requête, le système renvoie un identifiant de requête. Cependant, les attributs de la règle de transfert ne sont pas encore mis à jour. La tâche de mise à jour continue de s'exécuter en arrière-plan. Vous pouvez appeler ListRules pour consulter l'état de mise à jour des attributs de la règle de transfert :
Testez maintenant
Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.
Test
Autorisation RAM
|
alb:UpdateRuleAttribute |
update |
*LoadBalancer
*ServerGroup
|
Aucune | Aucune |
Paramètres de requête
|
Paramètre |
Type |
Requis |
Description |
Exemple |
| RuleId |
string |
Oui |
L'identifiant de la règle de transfert. |
rule-4dp5i6ea**** |
| ClientToken |
string |
Non |
Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer que le jeton est unique pour les différentes requêtes. Le jeton ne peut contenir que des caractères ASCII. Remarque
Si vous ne spécifiez pas ce paramètre, le système utilise automatiquement la valeur de RequestId comme valeur de ClientToken. La valeur de RequestId est différente pour chaque requête d'API. |
5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
| DryRun |
boolean |
Non |
Indique si un test à blanc uniquement doit être effectué, sans exécuter la requête réelle. Valeurs valides :
|
false |
| RuleConditions |
array<object> |
Non |
Les conditions de la règle de transfert. |
|
|
array<object> |
Non |
Les conditions de la règle de transfert. |
||
| CookieConfig |
object |
Non |
La configuration du cookie. |
|
| Values |
array<object> |
Non |
La configuration du cookie. |
|
|
object |
Non |
La configuration du cookie. |
||
| Key |
string |
Non |
The cookie key. The key must be 1 to 100 characters in length and can contain lowercase letters, printable characters, asterisks (*), and question marks (?). The key cannot contain spaces or |
test |
| Value |
string |
Non |
The cookie value. The value must be 1 to 128 characters in length and can contain lowercase letters, printable characters, asterisks (*), and question marks (?). The value cannot contain spaces or |
test |
| HeaderConfig |
object |
Non |
La configuration de l'en-tête. |
|
| Key |
string |
Non |
La clé de l'en-tête. La clé doit comporter de 1 à 40 caractères et peut contenir des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_). Cookie et Host ne sont pas pris en charge. |
Port |
| Values |
array |
Non |
Les valeurs de l'en-tête. |
|
|
string |
Non |
La valeur de l'en-tête. Les valeurs d'en-tête au sein d'une même condition de règle de transfert ne peuvent pas être dupliquées. Règles de nommage :
|
5006 |
|
| HostConfig |
object |
Non |
La configuration de l'hôte. |
|
| Values |
array |
Non |
Les noms d'hôte. |
|
|
string |
Non |
Le nom d'hôte. Règles de nommage :
|
www.example.com |
|
| MethodConfig |
object |
Non |
La configuration de la méthode de requête. |
|
| Values |
array |
Non |
Les méthodes de requête. |
|
|
string |
Non |
La méthode de requête. Valeurs valides : HEAD, GET, POST, OPTIONS, PUT, PATCH et DELETE. |
PUT |
|
| PathConfig |
object |
Non |
La configuration du chemin pour le transfert. |
|
| Values |
array |
Non |
Les chemins de transfert. |
|
|
string |
Non |
Le chemin de transfert. Règles de nommage :
|
/test |
|
| QueryStringConfig |
object |
Non |
La configuration de la chaîne de requête. |
|
| Values |
array<object> |
Non |
Les chaînes de requête. Vous pouvez ajouter jusqu'à 20 chaînes de requête. |
|
|
object |
Non |
La structure de la chaîne de requête. |
||
| Key |
string |
Non |
The query string key. The key must be 1 to 100 characters in length and can contain lowercase letters, printable characters, asterisks (*), and question marks (?). The key cannot contain spaces or |
test |
| Value |
string |
Non |
The query string value. The value must be 1 to 128 characters in length and can contain lowercase letters, printable characters, asterisks (*), and question marks (?). The value cannot contain spaces or |
test |
| Type |
string |
Non |
Le type de règle de transfert. Vous pouvez ajouter jusqu'à 7 types de règles de transfert. Valeurs valides :
|
Host |
| ResponseStatusCodeConfig |
object |
Non |
La configuration du code d'état de la réponse. |
|
| Values |
array |
Non |
La liste des codes d'état de la réponse. |
|
|
string |
Non |
Le code d'état de la réponse. |
301 |
|
| ResponseHeaderConfig |
object |
Non |
La configuration de la condition d'en-tête de réponse. |
|
| Key |
string |
Non |
La clé d'en-tête.
|
test |
| Values |
array |
Non |
Les valeurs de l'en-tête. |
|
|
string |
Non |
La valeur de l'en-tête.
|
50006 |
|
| SourceIpConfig |
object |
Non |
La configuration de correspondance de trafic IP source-service. Vous pouvez ajouter jusqu'à 5 conditions de correspondance de trafic IP source-service. |
|
| Values |
array |
Non |
Une ou plusieurs adresses IP ou blocs CIDR. |
|
|
string |
Non |
Une ou plusieurs adresses IP ou blocs CIDR. |
192.168.0.0/32 |
|
| RuleActions |
array<object> |
Non |
Les actions de la règle de transfert. |
|
|
array<object> |
Non |
Les actions de la règle de transfert. |
||
| FixedResponseConfig |
object |
Non |
La configuration de la réponse fixe. |
|
| Content |
string |
Non |
Le contenu fixe à renvoyer. Le contenu peut avoir une taille maximale de 1 Ko et ne peut contenir que des caractères ASCII. |
dssacav |
| ContentType |
string |
Non |
Le format du contenu fixe à renvoyer. Valeurs valides : text/plain, text/css, text/html, application/javascript et application/json. |
text/plain |
| HttpCode |
string |
Non |
Le code de réponse HTTP à renvoyer. Seules les chaînes numériques au format 2xx, 4xx et 5xx sont prises en charge, où x représente n'importe quel chiffre. |
200 |
| ForwardGroupConfig |
object |
Non |
La configuration du groupe de transfert. |
|
| ServerGroupTuples |
array<object> |
Non |
Les groupes de serveurs de destination vers lesquels les requêtes sont transférées. |
|
|
object |
Non |
La structure du groupe de serveurs de destination. |
||
| ServerGroupId |
string |
Non |
The ID of the destination server group to which requests are forwarded. |
sg--atstuj3rtoptyui**** |
| Weight |
integer |
Non |
The weight. A larger value specifies a higher weight, which means more requests are forwarded to the server group. Valid values: 0 to 100.
|
30 |
| ServerGroupStickySession |
object |
Non |
La configuration de la persistance de session entre les groupes de serveurs. |
|
| Enabled |
boolean |
Non |
Specifies whether to enable session persistence. Valid values:
|
false |
| Timeout |
integer |
Non |
The timeout period. Unit: seconds. Valid values: 1 to 86400. |
2 |
| InsertHeaderConfig |
object |
Non |
La configuration de l'insertion d'en-tête. |
|
| CoverEnabled |
boolean |
Non |
Indique si la valeur dans la requête doit être écrasée. Valeurs valides :
|
false |
| Key |
string |
Non |
Le nom de l'en-tête à insérer. Le nom doit comporter de 1 à 40 caractères et peut contenir des lettres majuscules et minuscules de a à z, des chiffres, des traits de soulignement (_) et des traits d'union (-). Le nom d'en-tête spécifié dans InsertHeaderConfig doit être unique. Remarque
Le nom de l'en-tête ne peut pas être défini sur les champs suivants (insensible à la casse) : |
key |
| Value |
string |
Non |
Le contenu de l'en-tête à insérer.
|
UserDefined |
| ValueType |
string |
Non |
Le type de contenu de la valeur de l'en-tête. Valeurs valides :
|
UserDefined |
| Order |
integer |
Non |
La priorité de l'action dans la règle de transfert. Valeurs valides : 1 à 50000. Les actions sont exécutées par ordre de priorité croissant. Cette valeur ne peut être ni vide ni dupliquée. Vous pouvez spécifier jusqu'à 20 priorités d'action. |
1 |
| RedirectConfig |
object |
Non |
La configuration de la redirection. Vous pouvez ajouter jusqu'à 20 redirections. |
|
| Host |
string |
Non |
L'hôte vers lequel rediriger. Valeurs valides :
|
www.example.com |
| HttpCode |
string |
Non |
Le type de redirection. Valeurs valides : 301, 302, 303, 307 et 308. |
301 |
| Path |
string |
Non |
Le chemin vers lequel rediriger. Valeurs valides :
|
/test |
| Port |
string |
Non |
Le port vers lequel rediriger. Valeurs valides :
|
10 |
| Protocol |
string |
Non |
Le protocole vers lequel rediriger. Valeurs valides :
Remarque
Les écouteurs HTTPS ne prennent en charge que les redirections vers HTTPS. |
HTTP |
| Query |
string |
Non |
La chaîne de requête vers laquelle rediriger. Valeurs valides :\n- ${query} (par défaut) : vous pouvez référencer ${host}, ${protocol} et ${port}. Chaque variable peut apparaître au maximum une fois. Ces variables peuvent être utilisées ensemble ou concaténées avec des caractères appartenant à la plage de valeurs autorisées indiquée ci-dessous.\n- Autres valeurs. Les restrictions relatives au jeu de caractères et au format sont les suivantes :\n - La chaîne de requête doit comporter entre 1 et 128 caractères.\n - La chaîne de requête peut contenir des caractères imprimables, mais ne peut pas contenir d'espaces ni les caractères |
quert |
| RewriteConfig |
object |
Non |
La configuration de la réécriture. |
|
| Host |
string |
Non |
L'adresse de l'hôte de destination pour les redirections internes. Valeurs valides :
|
www.example.com |
| Path |
string |
Non |
Le chemin vers lequel rediriger. Valeurs valides :
|
/tsdf |
| Query |
string |
Non |
La chaîne de requête pour les redirections internes. Valeurs valides :
|
quedsa |
| Type |
string |
Non |
Le type d'action. Vous pouvez ajouter jusqu'à 11 types d'actions. Valeurs valides :
Remarque
Une règle de transfert doit contenir une action ForwardGroup, Redirect ou FixedResponse. Lorsque cette action coexiste avec d'autres types d'actions, elle doit être la dernière à être exécutée. |
ForwardGroup |
| TrafficLimitConfig |
object |
Non |
La configuration de la limitation du trafic. |
|
| QPS |
integer |
Non |
Le nombre de requêtes par seconde (QPS). Valeurs valides : 1 à 1000000. |
100 |
| PerIpQps |
integer |
Non |
Le QPS par adresse IP. Valeurs valides : 1 à 1000000. Remarque
Si QPS et PerIpQps sont tous deux configurés, la valeur de PerIpQps doit être inférieure à celle de QPS. |
80 |
| TrafficMirrorConfig |
object |
Non |
La configuration de la mise en miroir du trafic. |
|
| TargetType |
string |
Non |
Le type de la cible de mise en miroir. Valeurs valides :\n- ForwardGroupMirror : met en miroir le trafic vers un groupe de serveurs. |
ForwardGroupMirror |
| MirrorGroupConfig |
object |
Non |
La configuration de la mise en miroir du trafic vers un groupe de serveurs. |
|
| ServerGroupTuples |
array<object> |
Non |
The configuration for mirroring traffic to a server group. |
|
|
object |
Non |
The configuration for mirroring traffic to a server group. |
||
| ServerGroupId |
string |
Non |
The server group ID. |
srg-00mkgijak0w4qgz9**** |
| RemoveHeaderConfig |
object |
Non |
La configuration de la suppression d'en-tête. |
|
| Key |
string |
Non |
Le nom de l'en-tête à supprimer. Le nom doit comporter de 1 à 40 caractères et peut contenir des lettres majuscules et minuscules de a à z, des chiffres, des traits de soulignement (_) et des traits d'union (-). Le nom de l'en-tête ne peut pas être dupliqué dans RemoveHeader.
|
test |
| CorsConfig |
object |
Non |
La configuration du partage de ressources cross-origin (CORS). |
|
| AllowOrigin |
array |
Non |
La liste des origines autorisées. Vous pouvez configurer un seul élément
|
|
|
string |
Non |
L'origine autorisée. |
http://test.com |
|
| AllowMethods |
array |
Non |
Les méthodes HTTP autorisées pour l'accès cross-origin. |
|
|
string |
Non |
La méthode HTTP autorisée pour l'accès cross-origin. Valeurs valides :
|
GET |
|
| AllowHeaders |
array |
Non |
La liste des en-têtes autorisés pour l'accès cross-origin. |
|
|
string |
Non |
Les en-têtes autorisés pour l'accès cross-origin. Vous pouvez définir cette valeur sur |
test_123 |
|
| ExposeHeaders |
array |
Non |
La liste des en-têtes qui peuvent être exposés. |
|
|
string |
Non |
Les en-têtes qui peuvent être exposés. Vous pouvez définir cette valeur sur |
test_123 |
|
| AllowCredentials |
string |
Non |
Indique si les informations d'identification sont autorisées. Valeurs valides :
|
on |
| MaxAge |
integer |
Non |
La durée maximale de mise en cache des requêtes preflight dans le navigateur. Unité : secondes. Valeurs valides : -1 à 172800. |
1000 |
| RuleName |
string |
Non |
Le nom de la règle de transfert. Le nom doit comporter entre 2 et 128 caractères et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_), des traits d'union (-) et des espaces. Le nom doit commencer par une lettre, un caractère chinois ou un chiffre. |
rule-instance-test |
| Priority |
integer |
Non |
La priorité de la règle. Valeurs valides : 1 à 10000. Une valeur plus faible indique une priorité plus élevée. Remarque
Les priorités des règles au sein d'un même écouteur doivent être uniques. |
10 |
Éléments de réponse
|
Élément |
Type |
Description |
Exemple |
|
object |
La réponse pour la mise à jour des attributs de la règle de transfert. |
||
| JobId |
string |
L'identifiant de la tâche asynchrone. |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
| RequestId |
string |
L'identifiant de la requête. |
365F5378-41F6-4AE4-92F8-7FF34B540710 |
Exemples
JSON format
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F5378-41F6-4AE4-92F8-7FF34B540710"
}
Codes d'erreur
|
Code de statut HTTP |
Code d'erreur |
Message d'erreur |
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. |
Consultez Codes d'erreur pour la liste complète.
Notes de version
Consultez Notes de version pour la liste complète.