CreateIpv4Gateway - - Centre de documentation Alibaba Cloud

Crée une passerelle IPv4.

Description de l'opération

CreateIpv4Gateway est une opération asynchrone. Après l'envoi d'une requête, le système renvoie un identifiant de requête et exécute la tâche en arrière-plan. Vous pouvez appeler l'opération GetIpv4GatewayAttribute pour interroger l'état d'une passerelle IPv4 :
- Si la passerelle IPv4 est dans l'état Creating, la passerelle IPv4 est en cours de création.
- Si la passerelle IPv4 est dans l'état Created, la passerelle IPv4 est créée.
Vous ne pouvez pas appeler de manière répétée l'opération CreateIpv4Gateway pour créer des passerelles IPv4 dans un cloud privé virtuel (VPC) dans un délai spécifié.

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

create

*Ipv4Gateway

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Ipv4GatewayName	string	Non	Le nom de la passerelle IPv4. Le nom doit comporter de 1 à 128 caractères et ne peut pas commencer par `http://` ou `https://`.	ipv4
Ipv4GatewayDescription	string	Non	La description de la passerelle IPv4. La description doit comporter de 1 à 256 caractères et ne peut pas commencer par `http://` ou `https://`.	test
VpcId	string	Oui	L'identifiant du VPC dans lequel vous souhaitez créer la passerelle IPv4. Vous ne pouvez créer qu'une seule passerelle IPv4 dans un VPC.	vpc-5tss06uvoyps5xoya****
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, la syntaxe 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, un code d'état HTTP 2xx est renvoyé et l'opération est exécutée.	false
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 qu'elle est unique parmi les différentes requêtes. ClientToken ne peut contenir que des caractères ASCII. Remarque Si vous ne définissez pas ce paramètre, le système définit ClientToken sur la valeur de RequestId. La valeur de RequestId est différente pour chaque requête API.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Oui	L'identifiant de la région dans laquelle vous souhaitez créer la passerelle IPv4. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	ap-southeast-6
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfmxazb4ph6aiy****
Tag	array<object>	Non	Les balises de la ressource.
	object	Non
Key	string	Non	La clé de la balise N à ajouter à la ressource. 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 la balise N à ajouter à la ressource. Vous pouvez spécifier jusqu'à 20 valeurs de balise. La valeur de la balise peut être une chaîne vide. La valeur de la balise peut comporter jusqu'à 128 caractères et ne peut pas contenir `http://` ou `https://`. La valeur de la balise ne peut pas commencer par `aliyun` ou `acs:`.	FinanceJoshua
RegionId	string	Oui	L'identifiant de la région dans laquelle vous souhaitez créer la passerelle IPv4. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	ap-southeast-6

Éléments de réponse

Élément	Type	Description	Exemple
	object
Ipv4GatewayId	string	L'identifiant de la passerelle IPv4.	ipv4gw-5tsnc6s4ogsedtp3k****
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmxazb4ph6aiy****
RequestId	string	L'identifiant de la requête.	F282742B-1BBB-5F63-A3AF-E92EC575A1A6

Exemples

JSON format

{
  "Ipv4GatewayId": "ipv4gw-5tsnc6s4ogsedtp3k****",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "RequestId": "F282742B-1BBB-5F63-A3AF-E92EC575A1A6"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	OperationDenied.ExistDirectEip	The operation is not allowed because of existing direct eip.	You are not allowed to create an IPv4 gateway because an EIP in cut-through mode exists.
400	UnsupportedRegion	The feature of ipv4Gateway is not supported in the region.	IPv4 gateways are not supported in this region.
400	Forbidden.OperateShareResource	You cannot operate shared resources.	Shared resources do not support this operation.
400	OperationDenied.SubnetRouteV1Exist	The operation is not allowed because of existing subnetRouteV1.	The subnet routes in the VPC do not meet the requirements.
400	OperationDenied.NormalNatExist	The operation is not allowed because of existing normalNat.	Standard NAT gateways are deployed in the specified VPC.
400	OperationDenied.VpcExistIpv4Gateway	An IPv4 gateway already exists in the VPC.	You are not allowed to create an IPv4 gateway in the VPC because an IPv4 gateway already exists in the VPC.
400	UnsupportedFeature.Ipv4Gateway	The feature of ipv4Gateway is not supported for [%s].	The system failed to create the IPv4 gateway because IPv4 gateways are not supported.
400	OperationDenied.VpnExist	The operation is not allowed because of existing vpn.	You are not allowed to create an IPv4 gateway because a VPN gateway already exists in the VPC.
400	OperationDenied.DirectEipExist	The operation is not allowed because of existing directEip.	EIPs are associated with the VPC in cut-through mode or enhanced NAT gateways are deployed in the VPC.
400	OperationFailed.GetNfvServiceList	The operation is failed because of get nfv serviceList failed.	Failed to obtain the nfc service list.
400	IncorrectStatus.Vpc	The status of %s [%s] is incorrect.	The instance is in an invalid state.
400	OperationFailed.VpcNotExist	The operation is failed because of vpc is not found.	The operation failed because the VPC is not found.
400	IllegalParam.ResourceGroupId	Invalid ResourceGroupld value.	The specified resource group is invalid or does not exist.

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

Notes de version

Consultez Notes de version pour la liste complète.