DescribeFirewallTask - - Centre de documentation Alibaba Cloud

Obtient une tâche de pare-feu.

Description de l'opération

Limite de QPS

La limite de QPS par utilisateur pour cette opération est de 10 appels par seconde. Si cette limite est dépassée, les appels d'API sont limités, ce qui peut affecter votre activité. Appelez cette opération de manière approprié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:DescribeFirewallTask

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Lang	string	Non	Le type de langue. Valeurs valides : zh (par défaut) : chinois en : anglais	zh
ChildInstanceId	string	Non	L'identifiant de l'instance enfant. Vous devez spécifier au moins l'un des paramètres ChildInstanceId et TaskId. Si les deux sont vides, l'erreur MissingParameter.TaskId (-360448) est renvoyée.	vfw-tr-cd6000c588214403****
TaskType	string	Non	Le type de la tâche. Valeurs valides : NAT : tâche de pare-feu NAT VPC : tâche de pare-feu VPC	VPC
TaskId	string	Non	L'identifiant de la tâche. Vous devez spécifier au moins l'un des paramètres TaskId et ChildInstanceId. Si les deux sont vides, l'erreur MissingParameter.TaskId (-360448, Au moins l'un des paramètres TaskId ou ChildInstanceId est requis.) est renvoyée.	199431783

Éléments de réponse

Élément	Type	Description	Exemple
	object
IsFound	boolean	Indique si la tâche existe.	false
TaskStatus	string	L'état de la tâche. Valeurs valides : init running finished rollback rollbackDone	init
TaskWaitingTime	string	Le temps d'attente, en minutes.	30
TaskSteps	array<object>	Les étapes de la tâche.
	object	Les étapes de la tâche.
StepStatus	string	L'état de l'étape de la tâche. Valeurs valides : init running finished failed	init
StepName	string	Le nom de l'étape de sécurité de Cloud Firewall.	Create Firewall
StepProgress	string	La progression de l'étape de la tâche.	80
StepInfo	string	Les informations sur la tâche.	abcd
RequestId	string	L'identifiant de la requête.	7D5483BF-2262-586D-8706-BDDB8B42****
TaskName	string	Le nom de la tâche.	egressgw
TaskStartTimestamp	string	L'heure à laquelle la tâche a été créée.	17151361285
TaskFinishTimestamp	string	L'heure à laquelle la tâche a été terminée.	17151381075
TaskId	integer	L'identifiant de la tâche.	189997648

Exemples

JSON format

{
  "IsFound": false,
  "TaskStatus": "init",
  "TaskWaitingTime": "30",
  "TaskSteps": [
    {
      "StepStatus": "init",
      "StepName": "Create Firewall",
      "StepProgress": "80",
      "StepInfo": "abcd"
    }
  ],
  "RequestId": "7D5483BF-2262-586D-8706-BDDB8B42****",
  "TaskName": "egressgw",
  "TaskStartTimestamp": "17151361285",
  "TaskFinishTimestamp": "17151381075",
  "TaskId": 189997648
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ErrorParameters	A parameter error occurred.
400	MissingParameter.TaskId	At least one of TaskId or ChildInstanceId is required.

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

Notes de version

Consultez Notes de version pour la liste complète.