DescribeNatFirewallControlPolicy - - Centre de documentation Alibaba Cloud

Consulte les stratégies de contrôle d'accès pour les pare-feu NAT.

Description de l'opération

Cette opération consulte les stratégies de contrôle d'accès pour les pare-feu NAT et renvoie les résultats sous forme de liste paginée.

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.

yundun-cloudfirewall:DescribeNatFirewallControlPolicy

list

*NatFirewallControlPolicy

acs:cloudfirewall::{#accountId}:natfirewallcontrolpolicy/{#AclUuid}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Lang	string	Non	La langue de la réponse. Valeurs valides : zh (par défaut) : chinois en : anglais	zh
NatGatewayId	string	Oui	L'identifiant de la passerelle NAT.	ngw-xxxxxx
CurrentPage	string	Non	Le numéro de la page actuelle pour une requête paginée.	1
PageSize	string	Non	Le nombre maximal d'entrées à renvoyer sur chaque page pour une requête paginée. La valeur par défaut est 10.	10
Source	string	Non	L'adresse source dans la stratégie de contrôle d'accès. Les requêtes floues sont prises en charge. La valeur de ce paramètre varie en fonction de la valeur du paramètre SourceType. Si SourceType est défini sur `net`, la valeur de ce paramètre est un bloc CIDR. Exemple : 192.0.XX.XX/24. Si SourceType est défini sur `group`, la valeur de ce paramètre est le nom d'un carnet d'adresses. Exemple : db_group. Si vous laissez ce paramètre vide, toutes les adresses source sont interrogées. Si SourceType est défini sur `location`, la valeur de ce paramètre est une région source. Exemple : Beijing ou beijing. Vous pouvez utiliser le chinois ou l'anglais pour spécifier la région. Remarque Si vous ne définissez pas ce paramètre, tous les types d'adresses source sont interrogés.	1.1.1.1/32
Destination	string	Non	L'adresse de destination dans la stratégie de contrôle d'accès. Les requêtes approximatives sont prises en charge. La valeur de ce paramètre varie en fonction de la valeur du paramètre DestinationType. Si DestinationType est défini sur net, la valeur de ce paramètre est un bloc CIDR. Exemple : 10.0.3.0/24. Si DestinationType est défini sur domain, la valeur de ce paramètre est un nom de domaine. Exemple : aliyun. Si DestinationType est défini sur group, la valeur de ce paramètre est le nom d'un carnet d'adresses. Exemple : db_group. Si DestinationType est défini sur location, la valeur de ce paramètre est un nom de région. Pour plus d'informations, consultez AddControlPolicy. Exemple : ["BJ11", "ZB"]. Remarque Si vous ne définissez pas ce paramètre, tous les types d'adresses de destination sont interrogés.	x.x.x.x/32
Description	string	Non	La description de la stratégie de contrôle d'accès. Les requêtes floues sont prises en charge. Remarque Si vous ne définissez pas ce paramètre, les descriptions de toutes les stratégies sont interrogées.	test-description
Proto	string	Non	Le type de protocole du trafic dans la stratégie de contrôle d'accès. Valeurs valides : TCP UDP ICMP ANY (tous les types de protocoles) Remarque Si vous ne définissez pas ce paramètre, tous les types de protocoles sont interrogés.	ANY
AclAction	string	Non	L'action que Cloud Firewall effectue sur le trafic. Valeurs valides : accept : Autoriser drop : Refuser log : Surveiller	accept
AclUuid	string	Non	L'identifiant unique de la stratégie de contrôle d'accès.	323f0697-2a21-4e43-b142-*****
Release	string	Non	L'état de la stratégie de contrôle d'accès. Par défaut, une stratégie de contrôle d'accès est activée après sa création. Valeurs valides : true : activé false : désactivé	true
Direction	string	Oui	La direction du trafic de la stratégie de contrôle d'accès. Valeurs valides : out : trafic sortant	out
RepeatType	string	Non	Le type de récurrence pour la période de validité de la stratégie. Valeurs valides : Permanent (par défaut) : toujours None : une seule fois Daily : quotidien Weekly : hebdomadaire Monthly : mensuel Valeurs valides : Daily : Quotidien. Monthly : Mensuel. Permanent : Toujours. Weekly : Hebdomadaire. None : Ponctuel.	Permanent

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalCount	string	Le nombre total d'entrées renvoyées.	28
RequestId	string	L'identifiant de la requête.	F283567D-8A52-5BAE-9472-*****
Policys	array<object>	Les informations sur les stratégies de contrôle d'accès pour le pare-feu NAT.
	object	Les informations sur les stratégies de contrôle d'accès pour le pare-feu NAT.
Destination	string	L'adresse de destination dans la stratégie de contrôle d'accès. La valeur de ce paramètre varie en fonction de la valeur du paramètre DestinationType. Valeurs valides : Si DestinationType est net, la valeur de ce paramètre est un bloc CIDR. Exemple : 192.0.XX.XX/24. Si DestinationType est domain, la valeur de ce paramètre est un nom de domaine. Exemple : aliyuncs.com. Si DestinationType est group, la valeur de ce paramètre est le nom d'un carnet d'adresses. Exemple : db_group. Si DestinationType est location, la valeur de ce paramètre est un nom de région. Pour plus d'informations, consultez AddControlPolicy. Exemple : ["BJ11", "ZB"].	x.x.x.x/32
Order	integer	La priorité de la stratégie de contrôle d'accès. La priorité commence à 1. Une valeur inférieure indique une priorité plus élevée.	1
DestPortGroup	string	Le nom du carnet d'adresses des ports de destination pour le trafic dans la stratégie de contrôle d'accès.	my_port_group
SourceType	string	Le type d'adresse source dans la stratégie de contrôle d'accès. Valeurs valides : net : bloc CIDR group : carnet d'adresses source location : région source	net
DnsResultTime	integer	L'horodatage de la résolution DNS. La valeur est un horodatage UNIX. Unité : secondes.	1579261141
DnsResult	string	Le résultat de la résolution DNS.	111.0.XX.XX,112.0.XX.XX
ApplicationNameList	array	Les noms des applications. Plusieurs applications sont prises en charge.
	string	Les noms des applications. Plusieurs applications sont prises en charge.	['HTTP', 'HTTPS']
AclUuid	string	L'identifiant unique de la stratégie de contrôle d'accès.	01281255-d220-4db1-8f4f-c4df221a****
DestPortType	string	Le type de port de destination du trafic dans la stratégie de contrôle d'accès. Valeurs valides : port : port group : carnet d'adresses de ports	port
Source	string	L'adresse source dans la stratégie de contrôle d'accès. Valeurs valides : Si SourceType est `net`, la valeur de ce paramètre est un bloc CIDR. Exemple : 192.0.XX.XX/24. Si SourceType est `group`, la valeur de ce paramètre est le nom d'un carnet d'adresses source. Exemple : db_group. Si SourceType est `location`, la valeur de ce paramètre est une région. Pour plus d'informations, consultez AddControlPolicy. Exemple : ["BJ11", "ZB"].	192.0.XX.XX/24
DestinationType	string	Le type d'adresse de destination dans la stratégie de contrôle d'accès. Valeurs valides : net : bloc CIDR de destination group : carnet d'adresses de destination domain : nom de domaine de destination location : région de destination	net
HitTimes	integer	Le nombre de correspondances pour la stratégie de contrôle d'accès.	100
HitLastTime	integer	L'horodatage de la dernière correspondance. La valeur est un horodatage UNIX. Unité : secondes.	1579261141
DestPort	string	Le port de destination pour le trafic dans la stratégie de contrôle d'accès.	80
Description	string	La description de la stratégie de contrôle d'accès.	test-description
AclAction	string	L'action que Cloud Firewall effectue sur le trafic. Valeurs valides : accept : Autoriser drop : Refuser log : Surveiller	accept
Proto	string	Le type de protocole du trafic dans la stratégie de contrôle d'accès. Valeurs valides : ANY TCP UDP ICMP	TCP
DestinationGroupCidrs	array	La liste des blocs CIDR dans le carnet d'adresses de destination de la stratégie de contrôle d'accès.
	string	La liste des blocs CIDR dans le carnet d'adresses de destination de la stratégie de contrôle d'accès.	[ "112.0.XX.XX/24", "112.0.XX.XX/32" ]
DestPortGroupPorts	array	La liste des ports dans le carnet d'adresses des ports de destination.
	string	La liste des ports dans le carnet d'adresses des ports de destination.	[80,443]
SourceGroupCidrs	array	La liste des blocs CIDR dans le carnet d'adresses source de la stratégie de contrôle d'accès.
	string	La liste des blocs CIDR dans le carnet d'adresses source de la stratégie de contrôle d'accès.	['192.0.XX.XX/24', '192.0.XX.XX/32']
Release	string	L'état de la stratégie de contrôle d'accès. Par défaut, une stratégie de contrôle d'accès est activée après sa création. Valeurs valides :\n\n- true : activée\n\n- false : désactivée	true
SourceGroupType	string	Le type de carnet d'adresses source dans la stratégie de contrôle d'accès. La valeur est fixée à ip. Cela indique un carnet d'adresses IP contenant un ou plusieurs blocs CIDR d'adresses IP.	ip
DestinationGroupType	string	Le type de carnet d'adresses de destination dans la stratégie de contrôle d'accès. Valeurs valides : ip : un carnet d'adresses IP contenant un ou plusieurs blocs CIDR d'adresses IP. domain : un carnet d'adresses de noms de domaine contenant un ou plusieurs noms de domaine.	ip
NatGatewayId	string	L'identifiant de la passerelle NAT.	ngw-xxxxxx
DomainResolveType	integer	La méthode de résolution de nom de domaine de la stratégie de contrôle d'accès. Par défaut, cette fonctionnalité est activée. Valeurs valides : 0 : basée sur FQDN 1 : résolution dynamique basée sur le DNS 2 : résolution dynamique basée sur FQDN et le DNS	0
SpreadCnt	string	Le nombre de spécifications de stratégie occupées. Il s'agit de la valeur cumulée du nombre de spécifications occupées par chaque stratégie. Le nombre de spécifications occupées par une seule stratégie = Nombre de blocs CIDR source × Nombre d'adresses de destination (blocs CIDR d'adresses IP, régions ou noms de domaine) × Nombre d'applications × Nombre de plages de ports.	10,000
CreateTime	integer	L'heure de création de la stratégie. La valeur est un horodatage UNIX. Unité : secondes.	1761062400
ModifyTime	integer	L'heure de la dernière modification de la stratégie. La valeur est un horodatage UNIX. Unité : secondes.	1761062400
RepeatType	string	Le type de récurrence pour la période de validité de la stratégie. Valeurs valides : Permanent (par défaut) : toujours None : une seule fois Daily : quotidien Weekly : hebdomadaire Monthly : mensuel Valeurs valides : Daily : Quotidien. Monthly : Mensuel. Permanent : Toujours. Weekly : Hebdomadaire. None : Spécifier une occurrence unique.	Permanent
RepeatDays	array	Les jours de la semaine ou du mois auxquels la stratégie doit se répéter. Si RepeatType est défini sur `Permanent`, `None` ou `Daily`, ce paramètre est un ensemble vide. Exemple : [] Si RepeatType est défini sur Weekly, ce paramètre ne peut pas être vide. Exemple : [0, 6] Remarque Si RepeatType est défini sur Weekly, les jours spécifiés dans RepeatDays ne peuvent pas être répétés. Si RepeatType est défini sur `Monthly`, ce paramètre ne peut pas être vide. Exemple : [1, 31] Remarque Si RepeatType est défini sur Monthly, les jours spécifiés dans RepeatDays ne peuvent pas être répétés.
	integer	Le jour de la semaine ou du mois auquel la stratégie se répète. Remarque Si RepeatType est défini sur Weekly, les valeurs valides vont de 0 à 6. La semaine commence le dimanche. Si RepeatType est défini sur Monthly, les valeurs valides vont de 1 à 31.	1
RepeatStartTime	string	L'heure de début de la récurrence. L'heure est au format HH:mm, sur 24 heures. Exemple : 08:00. Remarque Si RepeatType est défini sur Permanent ou None, ce paramètre est vide. Si RepeatType est défini sur Daily, Weekly ou Monthly, vous devez définir ce paramètre. L'heure est au format HH:mm, sur 24 heures. Exemples : 08:00 et 23:30.	08:00
RepeatEndTime	string	L'heure de fin de la récurrence. L'heure est au format HH:mm, sur 24 heures. Exemple : 23:00. Remarque Si RepeatType est défini sur Permanent ou None, ce paramètre est vide. Si RepeatType est défini sur Daily, Weekly ou Monthly, vous devez définir ce paramètre. L'heure est au format HH:mm, sur 24 heures. Exemples : 08:00 et 23:30.	23:30
StartTime	integer	L'heure de début de la période de validité de la stratégie. La valeur est un horodatage UNIX. Unité : secondes. L'heure doit correspondre à une heure pile ou une demi-heure, et précéder l'heure de fin d'au moins 30 minutes. Remarque Si RepeatType est défini sur Permanent, ce paramètre est vide. Si RepeatType est défini sur None, Daily, Weekly ou Monthly, vous devez définir ce paramètre.	1694761200
EndTime	integer	L'heure de fin de la période de validité de la stratégie. La valeur est un horodatage UNIX. Unité : secondes. L'heure doit être définie à l'heure pile ou à la demi-heure, et être postérieure d'au moins 30 minutes à l'heure de début. Remarque Si RepeatType est défini sur Permanent, ce paramètre est vide. Si RepeatType est défini sur None, Daily, Weekly ou Monthly, vous devez définir ce paramètre.	1694764800

Exemples

JSON format

{
  "TotalCount": "28",
  "RequestId": "F283567D-8A52-5BAE-9472-*****",
  "Policys": [
    {
      "Destination": "x.x.x.x/32",
      "Order": 1,
      "DestPortGroup": "my_port_group",
      "SourceType": "net",
      "DnsResultTime": 1579261141,
      "DnsResult": "111.0.XX.XX,112.0.XX.XX",
      "ApplicationNameList": [
        "['HTTP', 'HTTPS']"
      ],
      "AclUuid": "01281255-d220-4db1-8f4f-c4df221a****",
      "DestPortType": "port",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net",
      "HitTimes": 100,
      "HitLastTime": 1579261141,
      "DestPort": "80",
      "Description": "test-description",
      "AclAction": "accept",
      "Proto": "TCP",
      "DestinationGroupCidrs": [
        "[\n      \"112.0.XX.XX/24\",\n      \"112.0.XX.XX/32\"\n]"
      ],
      "DestPortGroupPorts": [
        "[80,443]"
      ],
      "SourceGroupCidrs": [
        "['192.0.XX.XX/24', '192.0.XX.XX/32']"
      ],
      "Release": "true",
      "SourceGroupType": "ip",
      "DestinationGroupType": "ip",
      "NatGatewayId": "ngw-xxxxxx",
      "DomainResolveType": 0,
      "SpreadCnt": "10,000",
      "CreateTime": 1761062400,
      "ModifyTime": 1761062400,
      "RepeatType": "Permanent",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.	Either pageSize or pageNo is invalid.
400	ErrorParameterIpVersion	The IP version is invalid.	The IP version is invalid.
400	ErrorParametersDirection	The direction is invalid.	The direction is invalid.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
400	ErrorUnmarshalJSON	An error occurred while parsing JSON.	An error occurred while decoding JSON.
400	ErrorParametersAppId	The AppId parameter is incorrect.	The AppId parameter is invalid.
400	ErrorParametersNatGatewayId	Invalid parameters NatGatewayId.	The request parameter NatGatewayId is invalid or does not exist.
400	ErrorUUIDNew	The UUID is invalid.	The UUID is invalid.
400	ErrorParametersSource	The source is invalid.	The source is invalid.
400	ErrorDomainResolve	An error occurred while resolving the domain.	An error occurred while resolving the domain.
400	ErrorParametersDestination	The Destination parameter is invalid.	The Destination parameter is invalid.
400	ErrorParametersProto	The protocol is invalid.	The protocol is invalid.
400	ErrorParametersDestPort	The dst_port is invalid.	The dst_port is invalid.
400	ErrorParametersAction	The action is invalid.	The action is invalid.
400	ErrorMarshalJSON	An error occurred while encoding JSON.	An error occurred while encoding JSON.
400	ErrorParametersAclUuid	Specified parameter AclUuid is not valid.	Specified parameter AclUuid is not valid.

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

Notes de version

Consultez Notes de version pour la liste complète.