ListCustomResponseCodeRules - Edge Security Acceleration - Centre de documentation Alibaba Cloud

Consulte la liste des configurations de codes de réponse personnalisés pour un site.

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:ListCustomResponseCodeRules

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'API ListSites.	340035003106221
ConfigId	integer	Non	L'identifiant de la configuration.	436490043994112
ConfigType	string	Non	Type de configuration. Vous pouvez utiliser ce paramètre pour interroger les configurations globales ou de règle. Valeurs valides : global : interroge les configurations globales. rule : interroge les configurations de règle. Valeurs valides : rule : Configuration de règle. global : Configuration globale.	global
RuleName	string	Non	Le nom de la règle.	rule_example
SiteVersion	integer	Non	Le numéro de version de la configuration du site. Pour les sites pour lesquels la gestion des versions de configuration est activée, vous pouvez utiliser ce paramètre pour spécifier la version du site pour laquelle la configuration prend effet. Valeur par défaut : 0.	0
PageNumber	integer	Non	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur maximale : 500. Valeur par défaut : 500.	20

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse.
RequestId	string	L'identifiant de la requête.	36af3fcc-43d0-441c-86b1-428951dc8225
Configs	array<object>	La liste des configurations de codes de réponse personnalisés.
	object	Les détails d'une configuration de code de réponse personnalisé.
ConfigId	integer	L'identifiant de la configuration.	395386449776640
SiteVersion	integer	Le numéro de version de la configuration du site. Pour les sites pour lesquels la gestion des versions de configuration est activée, vous pouvez utiliser ce paramètre pour spécifier la version du site pour laquelle la configuration prend effet. Valeur par défaut : 0.	0
Sequence	integer	L'ordre d'exécution de la règle. Une valeur plus petite indique une priorité plus élevée.	1
Rule	string	Le contenu de la règle, qui utilise des expressions conditionnelles pour faire correspondre les requêtes des utilisateurs. Vous n'avez pas besoin de définir ce paramètre lors de l'ajout d'une configuration globale. Deux scénarios d'utilisation sont pris en charge : Faire correspondre toutes les requêtes entrantes : définissez la valeur sur true. Faire correspondre des requêtes spécifiques : définissez la valeur sur une expression personnalisée, par exemple : (http.host eq "video.example.com").	(http.host eq "video.example.com")
RuleEnable	string	L'état d'activation de la règle. Vous n'avez pas besoin de définir ce paramètre lors de l'ajout d'une configuration globale. Valeurs valides : on : active la règle. off : désactive la règle.	on
RuleName	string	Le nom de la règle. Vous n'avez pas besoin de définir ce paramètre lors de l'ajout d'une configuration globale.	rule_example
ConfigType	string	Le type de configuration. Valeurs valides : global : configuration globale. rule : configuration de règle.	global
ReturnCode	string	Le code de réponse.	200
PageId	string	La page de réponse.	0
PageNumber	integer	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	La taille de la page. Valeur par défaut : 500. Valeurs valides : 1 à 500.	20
TotalCount	integer	Le nombre total d'entrées.	10
TotalPage	integer	Le nombre total de pages.	1

Exemples

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "SiteVersion": 0,
      "Sequence": 1,
      "Rule": "(http.host eq \"video.example.com\")",
      "RuleEnable": "on",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "ReturnCode": "200",
      "PageId": "0"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 10,
  "TotalPage": 1
}

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.
400	InvalidParameter.FunctionName	The specified feature does not exist. Specify a valid feature name based on the related documentation.	The specified feature does not exist. Specify a valid feature name based on the related documentation.

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

Notes de version

Consultez Notes de version pour la liste complète.