GatewayBlackWhiteList - - Centre de documentation Alibaba Cloud

Obtient les listes noires et les listes blanches de la passerelle.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
PageNumber	integer	Non	Le numéro de page. Plage de valeurs : entiers supérieurs à 0. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur par défaut : 1.	1
FilterParams	object	Non	Analyse à partir de filterParams.
GatewayId	integer	Non	L'identifiant de la passerelle.	81
GatewayUniqueId	string	Non	L'identifiant unique de la passerelle (lorsque GatewayId et GatewayUniqueId existent tous les deux, GatewayId est prioritaire).	gw-5017305290e14centbrveca****
ResourceType	string	Non	Non disponible pour le moment.	""
Type	string	Non	Non disponible pour le moment.	""
IsWhite	boolean	Non	Non disponible pour le moment.	""
SearchType	string	Non	Type de recherche :\n\n- ROUTE : recherche par route, saisissez le nom de la route dans SearchContent\n\n- DOMAIN : recherche par nom de domaine, saisissez le nom de domaine dans SearchContent\n\n- IP : recherche par adresse IP spécifiée, saisissez l'adresse IP dans SearchContent.	IP
SearchContent	string	Non	Le contenu de la recherche.	1.1.1.1
OrderItem	string	Non	Non disponible pour le moment.	""
DescSort	boolean	Non	Non disponible pour le moment.	""
AcceptLanguage	string	Non	La langue dans laquelle les résultats renvoyés sont affichés. Valeurs : zh (par défaut) : chinois, en : anglais.	zh

Éléments de réponse

Élément	Type	Description	Exemple
	object	RestResult<PageResult>
RequestId	string	L'identifiant de la requête.	58E06A0A-BD2C-47A0-99C2-B100F353****
Success	boolean	Le résultat de la requête. Valeurs valides : `true` : la requête a réussi. `false` : la requête a échoué.	true
Code	integer	Le code est uniquement utilisé pour la synchronisation en cas de succès.	200
ErrorCode	string	Le code d'erreur.	Success
HttpStatusCode	integer	Le code d'état HTTP.	200
Message	string	Le message renvoyé.	OK
DynamicCode	string	L'espace réservé dans les messages d'erreur dynamiques. Non utilisé actuellement, veuillez l'ignorer.	code
DynamicMessage	string	Le message dynamique. Non utilisé actuellement, veuillez l'ignorer.	Le paramètre spécifié n'est pas valide
Data	object	Les données renvoyées.
PageNumber	integer	Le numéro de page de la liste des instances.	1
TotalSize	integer	Le nombre total d'instances trouvées.	1
PageSize	integer	Le nombre de lignes par page défini en entrée.	1
Result	array<object>	La collection renvoyée.
	object
Id	integer	The blacklist or whitelist ID.	549
ResourceId	integer	The resource ID.	549
ResourceType	string	Effective granularity: GATEWAY: Gateway global DOMAIN: Domain name ROUTE: Route	GATEWAY
Content	string	The blacklist content.	1.1.1.1
IsWhite	boolean	Indicates whether it is a whitelist.	true
Type	string	The blacklist or whitelist type, currently fixed as IP blacklist or whitelist.	IP
Status	string	The blacklist or whitelist status. on: Enabled off: Disabled	on
GatewayId	integer	The gateway ID.	81
GatewayUniqueId	string	The unique identifier of the gateway.	gw-5017305290e14centbrveca****
GmtCreate	string	The creation time.	2024-08-02T02:43:40.000+0000
GmtModified	string	The modification time.	2024-08-02T02:43:40.000+0000
ResourceIdJsonList	string	The JSON list of resource IDs. If ResourceType is ROUTE, this is a list of route IDs If ResourceType is DOMAIN, this is a list of domain name IDs	[234]
Note	string	The remarks.	Blocked IP list
ResourceIdNameJson	string	The resource name description.	{}
Name	string	The blacklist name.	test

Exemples

JSON format

{
  "RequestId": "58E06A0A-BD2C-47A0-99C2-B100F353****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "Success",
  "HttpStatusCode": 200,
  "Message": "OK",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 1,
    "PageSize": 1,
    "Result": [
      {
        "Id": 549,
        "ResourceId": 549,
        "ResourceType": "GATEWAY",
        "Content": "1.1.1.1",
        "IsWhite": true,
        "Type": "IP",
        "Status": "on",
        "GatewayId": 81,
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "GmtCreate": "2024-08-02T02:43:40.000+0000",
        "GmtModified": "2024-08-02T02:43:40.000+0000",
        "ResourceIdJsonList": "[234]",
        "Note": "Blocked IP list",
        "ResourceIdNameJson": "{}",
        "Name": "test"
      }
    ]
  }
}

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.