DescribeControlPolicy - - Centre de documentation Alibaba Cloud

Obtient les informations sur toutes les stratégies de contrôle d'accès.

Description de l'opération

Cette opération est généralement utilisée pour la requête paginée des informations sur les stratégies de contrôle d'accès.

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

get

*ControlPolicyOrder

acs:cloudfirewall::{#accountId}:controlpolicy/{#AclUuid}/controlpolicyorder/{#Direction}

*ControlPolicy

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Lang	string	Non	Le type de langue pour la réception des messages. Valeurs valides :	zh
Direction	string	Non	La direction du trafic contrôlée par la stratégie de contrôle d'accès. Valeurs valides : in (entrant) ou out (sortant). Vous devez spécifier au moins l'un des paramètres Direction et AclUuid. Si AclUuid n'est pas spécifié, vous devez spécifier une valeur non vide pour Direction. Sinon, l'erreur ErrorParametersDirection est renvoyée. Valeurs valides : in : Entrant, qui indique le trafic des sources externes vers les ressources internes. out : Sortant, qui indique le trafic des ressources internes vers les destinations externes.	in
CurrentPage	string	Oui	Le numéro de la page actuelle affichée dans une requête paginée.	1
PageSize	string	Oui	Le nombre maximal d'entrées par page affichées dans une requête paginée.	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 varie en fonction du paramètre SourceType (type de source).	192.0.XX.XX
Destination	string	Non	L'adresse de destination dans la stratégie de contrôle d'accès. Les requêtes floues sont prises en charge. La valeur varie en fonction du paramètre DestinationType (type de destination).	192.0.XX.XX
Description	string	Non	La description de la stratégie de contrôle d'accès. Les requêtes floues sont prises en charge.	Autoriser l'accès au segment de réseau de bureau
Proto	string	Non	Le type de protocole du trafic dans la stratégie de contrôle d'accès. Valeurs valides :	TCP
AclAction	string	Non	L'action que Cloud Firewall effectue sur le trafic dans la stratégie de contrôle d'accès. Valeurs valides :	accept
Release	string	Non	L'état d'activation de la stratégie de contrôle d'accès. Valeurs valides :	true
AclUuid	string	Non	L'identifiant unique de la stratégie de contrôle d'accès. Vous devez spécifier au moins l'un des paramètres AclUuid et Direction. Si AclUuid est spécifié, vous pouvez interroger la stratégie par son identifiant.	00281255-d220-4db1-8f4f-c4df221a****
IpVersion	string	Non	La version d'adresse IP prise en charge. Valeurs valides : Valeurs valides : 4 : IPv4 6 : IPv6	6
RepeatType	string	Non	Le type de récurrence de la période de validité de la stratégie de contrôle d'accès. Valeurs valides : Valeurs valides : Daily : tous les jours. Monthly : tous les mois. Permanent : toujours. Weekly : toutes les semaines. None : une période ponctuelle spécifiée.	Permanent

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageNo	string	Le numéro de la page actuelle affichée dans une requête paginée.	1
PageSize	string	Le nombre maximal d'entrées par page affichées dans une requête paginée.	10
RequestId	string	L'identifiant de la requête.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****
TotalCount	string	Le nombre total de stratégies de contrôle d'accès.	100
Policys	array<object>	Les informations sur les stratégies de contrôle d'accès.
	object	Les détails de la stratégie de contrôle d'accès.
Direction	string	La direction du trafic de la stratégie de contrôle d'accès. Valeurs valides :	in
Order	integer	La priorité de la stratégie de contrôle d'accès.	1
SourceType	string	Le type de l'adresse source dans la stratégie de contrôle d'accès. Valeurs valides :	net
ApplicationName	string	Le type d'application pris en charge par la stratégie de contrôle d'accès. Nous vous recommandons d'utiliser ApplicationNameList. Valeurs valides :	HTTP
HitTimes	integer	Le nombre de correspondances pour la stratégie de contrôle d'accès.	100
Description	string	La description de la stratégie de contrôle d'accès.	Autoriser l'accès au segment de réseau de bureau
SourceGroupType	string	Le type du carnet d'adresses source dans la stratégie de contrôle d'accès. Valeurs valides :	ip
DnsResultTime	integer	L'horodatage de la résolution DNS. La valeur est un horodatage UNIX en secondes.	1579261141
DnsResult `deprecated`	string	Le résultat de la résolution DNS.	192.0.XX.XX,192.0.XX.XX
Proto	string	Le type de protocole de sécurité du trafic dans la stratégie de contrôle d'accès. Valeurs valides :	TCP
DestinationGroupType	string	Le type du carnet d'adresses de destination dans la stratégie de contrôle d'accès. Valeurs valides :	ip
Destination	string	L'adresse de destination dans la stratégie de contrôle d'accès. La valeur varie en fonction du paramètre DestinationType (type de destination). Valeurs valides :	192.0.XX.XX/24
HitLastTime	integer	L'heure de la dernière correspondance. La valeur est au format d'un horodatage UNIX en secondes.	1579261141
DestPortGroup	string	Le nom du carnet d'adresses des ports de destination dans la stratégie de contrôle d'accès.	my_port_group
AclUuid	string	L'identifiant unique de la stratégie de contrôle d'accès.	00281255-d220-4db1-8f4f-c4df221a****
DestPortType	string	Le type de port de destination dans la stratégie de contrôle d'accès. Valeurs valides :	port
Source	string	L'adresse source dans la stratégie de contrôle d'accès. Valeurs valides :	192.0.XX.XX/24
DestinationType	string	Le type de l'adresse de destination dans la stratégie de contrôle d'accès. Valeurs valides :	net
DestPort	string	Le port de destination du trafic dans la stratégie de contrôle d'accès.	80
IpVersion	integer	La version d'adresse IP prise en charge. Valeurs valides :	6
AclAction	string	L'action que Cloud Firewall effectue sur le trafic dans la stratégie de contrôle d'accès. Valeurs valides :	accept
Release	string	L'état d'activation de la stratégie de contrôle d'accès. La stratégie est activée par défaut après sa création. Valeurs valides :	true
ApplicationId	string	L'identifiant de l'application du trafic dans la stratégie de contrôle d'accès.	10***
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	Le bloc CIDR dans le carnet d'adresses de destination de la stratégie de contrôle d'accès.	192.0.XX.XX/24
DestPortGroupPorts	array	La liste des ports dans le carnet d'adresses des ports de destination.
	string	Le port dans le carnet d'adresses des ports de destination.	80/80
SourceGroupCidrs	array	La liste des blocs CIDR dans le carnet d'adresses source de la stratégie de contrôle d'accès.
	string	Le bloc CIDR dans le carnet d'adresses source de la stratégie de contrôle d'accès.	192.0.XX.XX/24
ApplicationNameList	array	La liste des noms d'application.
	string	La liste des types d'application pris en charge par la stratégie de contrôle d'accès. Valeurs valides :	HTTP
SpreadCnt	integer	Le nombre d'unités de quota consommées par la stratégie de contrôle d'accès, qui correspond au nombre cumulé d'unités de quota consommées par chaque stratégie.	10000
CreateTime	integer	L'heure de création de la stratégie. La valeur est un horodatage UNIX en secondes, qui correspond au nombre de secondes écoulées depuis le 1er janvier 1970 (UTC).	1761062400
ModifyTime	integer	L'heure de la dernière modification de la stratégie. La valeur est un horodatage UNIX en secondes, qui correspond au nombre de secondes écoulées depuis le 1er janvier 1970 (UTC).	1761062400
RepeatType	string	Le type de récurrence de la période de validité de la stratégie de contrôle d'accès. Valeurs valides : Valeurs valides : Daily : tous les jours. Monthly : tous les mois. Permanent : toujours. Weekly : toutes les semaines. None : une période ponctuelle spécifiée.	Permanent
RepeatDays	array	L'ensemble des jours de récurrence pour la période de validité de la stratégie de contrôle d'accès.
	integer	Le jour de récurrence pour la période de validité de la stratégie de contrôle d'accès.	1
RepeatStartTime	string	L'heure de début de récurrence de la période de validité de la stratégie de contrôle d'accès. Exemple : 08:00. La valeur doit être à l'heure ou à la demi-heure et doit précéder l'heure de fin de récurrence d'au moins 30 minutes.	08:00
RepeatEndTime	string	L'heure de fin de récurrence de la période de validité de la stratégie de contrôle d'accès. Exemple : 23:30. La valeur doit être à l'heure ou à la demi-heure et doit suivre l'heure de début de récurrence d'au moins 30 minutes.	23:30
StartTime	integer	L'heure de début de la période de validité de la stratégie de contrôle d'accès. La valeur est un horodatage UNIX en secondes. La valeur doit être à l'heure ou à la demi-heure et doit précéder l'heure de fin d'au moins 30 minutes.	1694761200
EndTime	integer	L'heure de fin de la période de validité de la stratégie de contrôle d'accès. La valeur est un horodatage UNIX en secondes. La valeur doit être à l'heure ou à la demi-heure et doit suivre l'heure de début d'au moins 30 minutes.	1694764800
DomainResolveType	string	La méthode de résolution de nom de domaine de la stratégie de contrôle d'accès. Valeurs valides :	FQDN

Exemples

JSON format

{
  "PageNo": "1",
  "PageSize": "10",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****",
  "TotalCount": "100",
  "Policys": [
    {
      "Direction": "in",
      "Order": 1,
      "SourceType": "net",
      "ApplicationName": "HTTP",
      "HitTimes": 100,
      "Description": "test",
      "SourceGroupType": "ip",
      "DnsResultTime": 1579261141,
      "DnsResult": "192.0.XX.XX,192.0.XX.XX",
      "Proto": "TCP",
      "DestinationGroupType": "ip",
      "Destination": "192.0.XX.XX/24",
      "HitLastTime": 1579261141,
      "DestPortGroup": "my_port_group",
      "AclUuid": "00281255-d220-4db1-8f4f-c4df221a****",
      "DestPortType": "port",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net",
      "DestPort": "80",
      "IpVersion": 6,
      "AclAction": "accept",
      "Release": "true",
      "ApplicationId": "10***",
      "DestinationGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "DestPortGroupPorts": [
        "80/80"
      ],
      "SourceGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "ApplicationNameList": [
        "HTTP"
      ],
      "SpreadCnt": 10000,
      "CreateTime": 1761062400,
      "ModifyTime": 1761062400,
      "RepeatType": "Permanent",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800,
      "DomainResolveType": "FQDN"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	ErrorParametersUid	The aliUid parameter is invalid.
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.
400	ErrorParameterIpVersion	The IP version is invalid.
400	ErrorParametersDirection	The direction is invalid.
400	ErrorDBSelect	An error occurred while querying database.
400	ErrorUnmarshalJSON	An error occurred while parsing JSON.
400	ErrorUUIDNew	The UUID is invalid.
400	ErrorParametersAppId	The AppId parameter is incorrect.
400	ErrorParametersSource	The source is invalid.
400	ErrorDomainResolve	An error occurred while resolving the domain.
400	ErrorParametersDestination	The Destination parameter is invalid.
400	ErrorParametersProto	The protocol is invalid.
400	ErrorParametersDestPort	The dst_port is invalid.
400	ErrorParametersAction	The action is invalid.
400	ErrorParameters	Parameters error.
400	ErrorMarshalJSON	An error occurred while encoding JSON.
400	ErrorParametersAclUuid	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.