CreateTrafficMirrorSession - Virtual Private Cloud - Centre de documentation Alibaba Cloud

Crée une session de mise en miroir du trafic.

Description de l'opération

L'API CreateTrafficMirrorSession est une API asynchrone, ce qui signifie que le système renvoie un identifiant d'instance, mais que la session de mise en miroir du trafic n'a pas encore été créée avec succès et que la tâche de création en arrière-plan est toujours en cours. Vous pouvez appeler ListTrafficMirrorSessions pour vérifier l'état de création de la session de mise en miroir du trafic :

Lorsque la session de mise en miroir du trafic est à l'état Creating, cela indique que la session est en cours de création.
Lorsque la session de mise en miroir du trafic est à l'état Created, cela indique que la création de la session est terminé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.

vpc:CreateTrafficMirrorSession

create

*TrafficMirrorSession

acs:vpc:{#regionId}:{#accountId}:trafficmirrorsession/*

*TrafficMirrorFilter

acs:vpc:{#regionId}:{#accountId}:trafficmirrorfilter/{#TrafficMirrorFilterId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
TrafficMirrorSessionDescription	string	Non	La description de la session de mise en miroir du trafic. La description doit comporter de 1 à 256 caractères et ne peut pas commencer par `http://` ou `https://`.	Ceci est une session de mise en miroir du trafic
TrafficMirrorSessionName	string	Non	Le nom de la session de mise en miroir du trafic. Le nom doit comporter de 1 à 128 caractères et ne peut pas commencer par `http://` ou `https://`.	test
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer la valeur, mais vous devez vous assurer que cette valeur est unique pour toutes les requêtes. Le jeton client ne peut contenir que des caractères ASCII. Remarque Si vous ne définissez pas ce paramètre, le système utilise RequestId comme ClientToken. RequestId peut être différent pour chaque requête d'API.	0c593ea1-3bea-11e9-b96b-88e9fe63****
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides : true : effectue un test à blanc. Le système vérifie les paramètres requis, le format de la requête et les limites. Si la requête échoue au test à blanc, un message d'erreur est renvoyé. Si la requête réussit le test à blanc, le code d'erreur `DryRunOperation` est renvoyé. false (par défaut) : effectue un test à blanc et envoie la requête. Si la requête réussit le test à blanc, l'opération est exécutée.	false
TrafficMirrorTargetId	string	Oui	L'identifiant de la destination de mise en miroir du trafic. Vous pouvez spécifier uniquement une interface réseau élastique (ENI) ou une instance Server Load Balancer (SLB) comme destination de mise en miroir du trafic.	eni-j6c8znm5l1yt4sox****
TrafficMirrorTargetType	string	Oui	Le type de la destination de mise en miroir du trafic. Valeurs valides : NetworkInterface : une ENI SLB : une instance SLB	NetworkInterface
TrafficMirrorFilterId	string	Oui	L'identifiant du filtre.	tmf-j6cmls82xnc86vtpe****
VirtualNetworkId	integer	Non	L'identifiant de réseau VXLAN (VNI). Valeurs valides : 0 à 16777215. Vous pouvez utiliser les VNI pour identifier le trafic mis en miroir provenant de différentes sessions au niveau de la destination de mise en miroir du trafic. Vous pouvez spécifier un VNI personnalisé ou utiliser un VNI aléatoire alloué par le système. Si vous souhaitez que le système alloue un VNI de manière aléatoire, ne saisissez aucune valeur.	1
Priority	integer	Oui	La priorité de la session de mise en miroir du trafic. Valeurs valides : 1 à 32766. Une valeur plus petite indique une priorité plus élevée. Vous ne pouvez pas spécifier des priorités identiques pour des sessions de mise en miroir du trafic créées dans la même région en utilisant le même compte.	1
Enabled	boolean	Non	Indique si la session de mise en miroir du trafic doit être activée. Valeurs valides : false (par défaut) : n'active pas la session de mise en miroir du trafic. true : active la session de mise en miroir du trafic.	false
PacketLength	integer	Non	L'unité de transmission maximale. Valeurs valides : 64 à 9600. Valeur par défaut : 1500.	1500
TrafficMirrorSourceIds	array	Oui	L'identifiant de la source de mise en miroir du trafic. Vous pouvez spécifier uniquement une interface réseau élastique (ENI) comme source de mise en miroir du trafic. La valeur par défaut de N est 1, ce qui indique que vous ne pouvez ajouter qu'une seule source de mise en miroir du trafic à une session de mise en miroir du trafic.	eni-j6c2fp57q8rr47rp****
	string	Non	L'identifiant de la source de mise en miroir du trafic. Vous pouvez spécifier uniquement une ENI comme source de mise en miroir du trafic. La valeur par défaut de N est 1, ce qui signifie que vous ne pouvez ajouter qu'une seule source de mise en miroir du trafic à une session de mise en miroir du trafic.	eni-j6c2fp57q8rr47rp****
RegionId	string	Oui	L'identifiant de la région à laquelle la session de mise en miroir du trafic appartient. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions la plus récente. Pour plus d'informations sur les régions qui prennent en charge la mise en miroir du trafic, consultez Présentation de la mise en miroir du trafic.	cn-hongkong
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel le trafic mis en miroir appartient.	rg-bp67acfmxazb4ph****
Tag	array<object>	Non	La balise de la ressource.
	object	Non	La balise de la ressource.
Key	string	Non	La clé de balise. Vous pouvez spécifier jusqu'à 20 clés de balise. La clé de balise ne peut pas être une chaîne vide. La clé de balise peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.	FinanceDept
Value	string	Non	La valeur de balise. Vous pouvez spécifier jusqu'à 20 valeurs de balise. La valeur de balise peut être une chaîne vide. La valeur de balise peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.	FinanceJoshua

Éléments de réponse

Élément	Type	Description	Exemple
	object
TrafficMirrorSessionId	string	L'identifiant de la session de mise en miroir du trafic.	tms-j6ce5di4w7nvigfjz****
RequestId	string	L'identifiant de la requête.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
ResourceGroupId	string	L'identifiant du groupe de ressources auquel le trafic mis en miroir appartient.	rg-bp67acfmxazb4ph****

Exemples

JSON format

{
  "TrafficMirrorSessionId": "tms-j6ce5di4w7nvigfjz****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "ResourceGroupId": "rg-bp67acfmxazb4ph****"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IncorrectBusinessStatus.TrafficMirror	The business status of traffic mirror is incorrect.	Traffic mirroring is in an invalid state.
400	OptInRequired.TrafficMirror	You need to subscribe to the traffic mirror service first.	Traffic mirroring is disabled.
400	DuplicatedParam.SourceInstanceIds	The parameter of source instance IDs contains duplicate values.	Duplicate values are set for TrafficMirrorSourceIds.N.
400	OperationDenied.DuplicateRole	The network interface must not be the source and the target of traffic mirror sessions at the same time.	A network interface controller (NIC) cannot be used as both the traffic mirror source and traffic mirror destination of a traffic mirror session at the same time.
400	ResourceNotFound.NetworkInterface	The specified resource of %s is not found.	The error message returned because NetworkInterface is set to an invalid value.
400	ResourceNotFound.EcsInstance	The specified resource of ECS instance is not found.	The specified ECS instance does not exist.
400	ResourceNotFound.Slb	The specified resource of SLB is not found.	The specified SLB instance does not exist.
400	OperationDenied.SlbNotInVpc	The specified SLB is not in any VPC.	The specified SLB instance does not belong to any VPC.
400	ResourceNotFound.TrafficMirrorFilter	The specified resource of traffic mirror filter is not found.	The specified filter does not exist.
400	IncorrectStatus.TrafficMirrorFilter	The status of traffic mirror filter is incorrect.	The filter is in an invalid state.
400	OperationDenied.EcsNotSupportTrafficMirror	The ECS instance does not support traffic mirroring.	The ECS instance does not support the traffic mirroring feature.
400	QuotaExceeded.SessionNum	The quota of the number of traffic mirror sessions is exceeded.	The number of traffic mirror sessions has reached the upper limit.
400	QuotaExceeded.FilterRelatedSession	The quota of the number of traffic mirror sessions related to one filter is exceeded.	The number of traffic mirror sessions associated with the filter has reached the upper limit.
400	QuotaExceeded.SourceNumPerSession	The quota of the number of traffic mirror sources per session is exceeded.	The number of traffic mirror sources associated with a traffic mirror session has reached the upper limit.
400	QuotaExceeded.NetworkInterfaceRelatedSession	The quota of the number of traffic mirror sessions related to one network interface is exceeded.	The number of traffic mirror sessions associated with an ENI has reached the upper limit.
400	QuotaExceeded.SlbRelatedSession	The quota of the number of traffic mirror sessions related to one SLB is exceeded.	The number of traffic mirror sessions associated with an SLB instance has reached the upper limit.
400	UnsupportedRegion	The feature is not supported in current region.	The feature is not supported in the current region.
400	InvalidLoadBalancerId.NotFound	The specified resource of load balancer is not found.	The SLB instance does not exist.
400	OperationDenied.FreeNetworkInterface	The network interface is not attached to any ECS instance.	The ENI is not associated with an ECS instance.
400	OperationDenied.ClassicSLB	The operation is not allowed because of ClassicSLB.	The error message returned because you cannot perform the operation on a CLB instance.
400	ResourceNotFound.TargetInstance	The specified target instance for traffic mirroring is not found.	The specified traffic mirror destination does not exist.
400	QuotaExceeded.SourceNumPerTarget	The maximum number of traffic mirror sources for a target is exceeded.	The number of traffic mirror sources associated with the image exceeds the upper limit.
400	IncorrectStatus.NetworkInterface	The status of network interface is incorrect.	The status of the ENI is invalid.
400	OperationFailed.NotSupportBizType	The specified instance type does not support the operation.	The specified instance type does not support the operation.
400	IllegalParam.Priority	The specified Priority is illegal or the same as other mirroring sessions.	The specified Priority is illegal or identical to another mirroring session
400	OperationDenied.UnsupportedTargetType	Traffic mirror target must be SLB if traffic mirror sources contain nat gateway network interface.	When a NAT gateway NIC exists in the traffic mirroring source, the traffic mirroring purpose must be SLB type.
400	OperationDenied.TargetTypeNotSupportGatewayLoadBalancerEndpoint	Operation denied because of target type can not be GatewayLoadBalancerEndpoint.	Gateway-based load balancing endpoints are not supported as traffic mirrors mu d
400	OperationDenied.TargetTypeNotSupportBondEni	Operation denied because of target type can not be Bond Network Interface.	Operation denied because of target type can not be Bond Network Interface.
400	OperationDenied.InvalidTargetBondEniType	The traffic mirroring target does not support the entered bond ENI type.	The traffic mirroring target does not support the entered bond ENI type.
400	OperationDenied.InvalidSourceBondEniType	The traffic mirroring source does not support the entered bond ENI type.	The traffic mirroring source does not support the entered bond ENI type.
400	OperationDenied.TargetTypeNotSupportTrafficMirrorFullPacket	The traffic mirror session target type does not support the feature of mirroring source full packet.	The traffic mirror session target type does not support the feature of mirroring source full packet
400	OperationDenied.TrafficMirrorSessionSourceFullPacketNotSupport	The traffic mirror session does not support the feature of mirroring source full packet.	Traffic mirror currently does not support source full packet mirroring. TrafficMirrorSourceTruncateMode can only be set to 0, which is the default mode.
400	QuotaExceeded.SessionNumPerTarget	The quota of the number of traffic mirror sessions per target is exceeded.
400	OperationDenied.NotSupportBondEniAsTrafficMirrorSource	The operation is not allowed because bond eni cannot be the source of traffic mirror.	Bond eni is not allowed to be the source of traffic mirror.
400	IncorrectStatus.TrafficMirrorSessionTarget	The status of the target of the traffic mirror session is incorrect.	The status of the intent of the traffic mirroring session is incorrect.
404	ResourceNotFound.GatewayLoadBalancerEndpoint	GatewayLoadBalancerEndpoint instance not found.	GatewayLoadBalancerEndpoint instance not found.

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

Notes de version

Consultez Notes de version pour la liste complète.