ListWaitingRooms - Edge Security Acceleration - Centre de documentation Alibaba Cloud

Consulte les détails de toutes les salles d'attente configurées pour un site spécifié.

Description de l'opération

Cette API vous permet de consulter les détails de configuration de toutes les salles d'attente pour un site spécifié, y compris l'état d'activation, le nom et les règles de file d'attente.

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

Aucune autorisation n'est requise pour cette opération. En cas de problème, contactez le support technique.

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
SiteId	integer	Oui	L'identifiant du site. Vous pouvez appeler l'opération ListSites pour obtenir l'identifiant du site.	120876698010528
WaitingRoomId	string	Non	L'identifiant de la salle d'attente. Spécifiez ce paramètre pour consulter les détails d'une salle d'attente spécifique.	6a51d5bc6460887abd1291dc7d4d****

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse de la requête.
RequestId	string	L'identifiant de la requête, utilisé pour tracer les appels d'API.	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
WaitingRooms	array<object>	La liste des salles d'attente.
	array<object>	Les détails de la salle d'attente.
WaitingRoomId	string	L'identifiant de la salle d'attente, qui identifie de manière unique une salle d'attente.	6a51d5bc6460887abd1291dc7d4d****
Enable	string	L'état d'activation. Valeurs valides : on : Activé. off : Désactivé.	on
Name	string	Le nom de la salle d'attente.	Salle d'attente de test
QueueAllEnable	string	Indique si tous les visiteurs doivent être mis en file d'attente. Valeurs valides : on : Activé. off : Désactivé.	on
HostNameAndPath	array<object>	Les configurations de nom d'hôte et de chemin.
	object	Les détails du nom d'hôte et du chemin.
Subdomain	string	The subdomain.	test.
Domain	string	The domain name.	example.com
Path	string	The path.	/test
CookieName	string	Le nom du cookie personnalisé.	__aliwaitingroom_example
TotalActiveUsers	string	Le nombre total d'utilisateurs actifs.	300
NewUsersPerMinute	string	Le nombre de nouveaux utilisateurs par minute.	200
SessionDuration	string	La durée de la session, en minutes.	3600
DisableSessionRenewalEnable	string	Indique si le renouvellement de session doit être désactivé. Valeurs valides : on : Activé. off : Désactivé.	on
QueuingMethod	string	La méthode de mise en file d'attente. Valeurs valides : random : Aléatoire. fifo : Premier entré, premier sorti. passthrough : Transmission directe. reject-all : Tout rejeter.	random
QueuingStatusCode	string	Le code d'état de la salle d'attente. Valeurs valides : 200 202 429	200
JsonResponseEnable	string	Indique si la réponse JSON doit être activée. Lorsqu'elle est activée, les requêtes avec un en-tête Accept contenant « application/json » renvoient des données JSON. Valeurs valides : on : Activé. off : Désactivé.	on
Description	string	La description de la salle d'attente.	Salle d'attente de test
WaitingRoomType	string	Le type de salle d'attente. Valeurs valides : default : Type par défaut. custom : Type personnalisé.	default
CustomPageHtml	string	Le contenu HTML ou l'identifiant de la page de file d'attente personnalisée. Ce paramètre n'est valide que lorsque WaitingRoomType est défini sur custom. Le contenu doit être encodé en URL.	Contenu HTML personnalisé
Language	string	La langue de la page de la salle d'attente. Ce paramètre est requis lorsque le type de salle d'attente est default. Valeurs valides : enus : Anglais. zhcn : Chinois simplifié. zhhk : Chinois traditionnel.	zhcn

Exemples

JSON format

{
  "RequestId": "CB1A380B-09F0-41BB-A198-72F8FD6DA2FE",
  "WaitingRooms": [
    {
      "WaitingRoomId": "6a51d5bc6460887abd1291dc7d4d****\n",
      "Enable": "on",
      "Name": "Test waiting room",
      "QueueAllEnable": "on",
      "HostNameAndPath": [
        {
          "Subdomain": "test.\n",
          "Domain": "example.com\n",
          "Path": "/test"
        }
      ],
      "CookieName": "__aliwaitingroom_example",
      "TotalActiveUsers": "300",
      "NewUsersPerMinute": "200",
      "SessionDuration": "3600",
      "DisableSessionRenewalEnable": "on",
      "QueuingMethod": "random",
      "QueuingStatusCode": "200",
      "JsonResponseEnable": "on",
      "Description": "Test waiting room",
      "WaitingRoomType": "default",
      "CustomPageHtml": "Custom HTML content",
      "Language": "zhcn"
    }
  ]
}

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.