ListWaitingRoomRules - Edge Security Acceleration - Centre de documentation Alibaba Cloud

Description de l'opération

Cette API permet aux utilisateurs de consulter la liste des règles de contournement de salle d'attente associées à un site spécifique.

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

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

esa:ListWaitingRoomRules

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
SiteId	integer	Oui	L'identifiant du site, qui peut être obtenu en appelant l'interface ListSites.	123456****
WaitingRoomId	string	Oui	L'identifiant de la salle d'attente à contourner, qui peut être obtenu en appelant l'interface ListWaitingRooms.	6a51d5bc6460887abd129****
WaitingRoomRuleId	integer	Non	L'identifiant de la règle de contournement de salle d'attente à mettre à jour, qui peut être obtenu en appelant l'interface ListWaitingRoomRules.	37286782688****
RuleName	string	Non	Le nom de la règle, facultatif, utilisé pour effectuer une requête par nom de règle de contournement de salle d'attente.	test

Éléments de réponse

Élément	Type	Description	Exemple
	object	Résultat de la réponse à la requête.
RequestId	string	L'identifiant de la requête, utilisé pour suivre l'état de l'appel.	15C66C7B-671A-4297-9187-2C4477247A123425345
WaitingRoomRules	array<object>	La liste des règles de contournement de salle d'attente.
	object	Les détails de la règle de contournement de salle d'attente.
WaitingRoomRuleId	integer	L'identifiant de la règle.	37286782688****
RuleName	string	Le nom de la règle. Ce paramètre n'a pas besoin d'être défini lors de l'ajout d'une configuration globale.	ip
RuleEnable	string	Le commutateur de la règle. Ce paramètre n'a pas besoin d'être défini lors de l'ajout d'une configuration globale. Valeurs valides :\n- on : activé.\n- off : désactivé.	on
Rule	string	Le contenu de la règle, utilisant des expressions conditionnelles pour faire correspondre les requêtes utilisateur. Ce paramètre n'a pas besoin d'être défini lors de l'ajout d'une configuration globale. Il existe deux scénarios d'utilisation :\n- Faire correspondre toutes les requêtes entrantes : définir la valeur sur true.\n- Faire correspondre des requêtes spécifiques : définir la valeur sur une expression personnalisée, par exemple (http.host eq "video.example.com").	(http.request.uri.path.file_name eq "jpg")

Exemples

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A123425345",
  "WaitingRoomRules": [
    {
      "WaitingRoomRuleId": 0,
      "RuleName": "ip",
      "RuleEnable": "on",
      "Rule": "(http.request.uri.path.file_name eq \\\"jpg\\\")"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
403	Site.NotExist	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.