ListWebFlowRules - - Centre de documentation Alibaba Cloud

Consulte les règles de protection des paramètres hotspot pour les requêtes HTTP.

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.

mse:ListWebFlowRules

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Namespace	string	Non	L'espace de noms.	default
AppName	string	Oui	Le nom de l'application.	spring-cloud-a
ResourceSearchKey	string	Non	Le mot-clé d'interface que vous pouvez rechercher dans les règles de protection. Ce paramètre est mutuellement exclusif avec le paramètre Resource.	flow
AppId	string	Non	L'identifiant de l'application.	b22qb1**@2f0586be4b1**
Resource	string	Non	L'interface à laquelle la règle de protection s'applique. Ce paramètre est mutuellement exclusif avec le paramètre ResourceSearchKey.	/flow
PageIndex	integer	Non	La première page à exporter. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées à retourner sur chaque page.	10
AcceptLanguage	string	Non	La langue dans laquelle les résultats renvoyés sont affichés. Valeurs valides : zh (par défaut) : chinois. en : anglais.	zh

Éléments de réponse

Élément	Type	Description	Exemple
	object
Code	integer	Le code de réponse.	200
Message	string	Le message renvoyé.	OK
RequestId	string	L'identifiant de la requête.	4AE73569-304C-5AA9-AE11-C1D99C7D1689
Success	boolean	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true
Data	object	Les données renvoyées.
Result	array<object>	Les résultats renvoyés.
	object	Informations sur la règle.
Namespace	string	The namespace.	default
StatIntervalMs	integer	The length of the time window. Unit: milliseconds.	1000
RuleId	string	The rule ID.	1
AppName	string	The application name.	spring-cloud-a
Resource	string	The name of the interface resource.	/flow
ResourceType	integer	The resource type 0: custom interface 1: WEB 2: RPC	1
ControlBehavior	integer	The flow control method. Valid values: 0: fast failure 2: wait in queue	0
Burst	integer	The number of additional requests allowed for burst requests. The effect is equivalent to the maximum number of tokens for the token bucket algorithm.	0
MaxQueueingTimeMs	integer	The timeout period for queuing when the ControlBehavior parameter is set to 2. Unit: milliseconds.	200
ResourceMode	integer	The resource mode. Valid values: 0: resource name mode	0
Threshold	number	The threshold.	20
Enable	boolean	Indicates whether the rule is enabled or disabled. `true`: enabled. `false`: disabled.	true
ParamItem	string	The parameter description item, which is a JSON string containing the following key-value pairs: parseStrategy: the parameter property (0: client IP address. 1: remote host. 2: header. 3: URL parameter) fieldName: the header name or URL parameter name. You must specify this key only if parseStrategy is set to 2 or 3 matchStrategy: the method to match the property value. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched. Valid values: 0 (exact match), 2 (regular expression match), and 3 (substring match) pattern: the match string. You must specify this key only if parseStrategy is set to 2 or 3 and the property value is matched	{"fieldName":"testKey","matchStrategy":2,"parseStrategy":2,"pattern":"testValue"}
AppId	string	The application ID.	hkhon1XXXX@c3df23522bXXXXX
MetricType	integer	The threshold type. Valid values: 1: number of requests	1
RegionId	string	The region ID.	cn-hangzhou
FallbackObject	string	The behavior that was bound to the rule.	{\"appName\":\"spring-cloud-a\",\"fallbackBehavior\":{\"webFallbackMode\":0,\"webRespContentType\":0,\"webRespMessage\":\"Blocked\",\"webRespStatusCode\":429},\"id\":977,\"name\":\"Fallback\",\"namespace\":\"default\",\"resourceClassification\":1}
PageNumber	integer	Le numéro de page.	1
PageSize	integer	Le nombre d'entrées renvoyées par page.	10
TotalSize	integer	Le nombre total de règles interrogées.	36
HttpStatusCode	integer	Le code d'état HTTP.	200

Exemples

JSON format

{
  "Code": 200,
  "Message": "OK",
  "RequestId": "4AE73569-304C-5AA9-AE11-C1D99C7D1689",
  "Success": true,
  "Data": {
    "Result": [
      {
        "Namespace": "default",
        "StatIntervalMs": 1000,
        "RuleId": "1",
        "AppName": "spring-cloud-a",
        "Resource": "/flow",
        "ResourceType": 1,
        "ControlBehavior": 0,
        "Burst": 0,
        "MaxQueueingTimeMs": 200,
        "ResourceMode": 0,
        "Threshold": 20,
        "Enable": true,
        "ParamItem": "{\"fieldName\":\"testKey\",\"matchStrategy\":2,\"parseStrategy\":2,\"pattern\":\"testValue\"}",
        "AppId": "hkhon1XXXX@c3df23522bXXXXX",
        "MetricType": 1,
        "RegionId": "cn-hangzhou",
        "FallbackObject": "{\\\"appName\\\":\\\"spring-cloud-a\\\",\\\"fallbackBehavior\\\":{\\\"webFallbackMode\\\":0,\\\"webRespContentType\\\":0,\\\"webRespMessage\\\":\\\"Blocked\\\",\\\"webRespStatusCode\\\":429},\\\"id\\\":977,\\\"name\\\":\\\"Fallback\\\",\\\"namespace\\\":\\\"default\\\",\\\"resourceClassification\\\":1}"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalSize": 36
  },
  "HttpStatusCode": 200
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

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

Notes de version

Consultez Notes de version pour la liste complète.