CreateTransitRouter - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Appelez l'opération CreateTransitRouter pour créer un routeur de transit Édition Entreprise. Pour connaître les régions qui prennent en charge les routeurs de transit Édition Entreprise, consultez la rubrique Qu'est-ce que CEN ?
L'opération CreateTransitRouter est asynchrone. Après l'envoi de la requête, l'ID du routeur de transit est renvoyé, mais l'opération s'exécute toujours en arrière-plan. Appelez l'opération ListTransitRouters pour interroger le statut d'un routeur de transit Édition Entreprise.
- Si un routeur de transit Édition Entreprise se trouve dans l'état Creating, il est en cours de création. Dans ce cas, vous pouvez interroger le routeur de transit, mais aucune autre opération n'est possible.
- Si un routeur de transit Édition Entreprise se trouve dans l'état Active, sa création est terminée.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	CreateTransitRouter	Opération à effectuer. Définissez la valeur sur CreateTransitRouter.
ClientToken	String	No	02fb3da4-130e-11e9-8e44-001****	Jeton client utilisé pour garantir l'idempotence de la requête. Générez une valeur via le client, en veillant à son unicité parmi toutes les requêtes. Le jeton ne peut contenir que des caractères ASCII. Remarque Si vous ne définissez pas ce paramètre, le système utilise automatiquement RequestId comme ClientToken. La valeur de RequestId varie selon les requêtes API.
CenId	String	Yes	cen-j3jzhw1zpau2km****	ID de l'instance Cloud Enterprise Network (CEN).
RegionId	String	Yes	cn-zhangjiakou	ID de la région où le routeur de transit Édition Entreprise est déployé. Appelez l'opération DescribeChildInstanceRegions pour obtenir la liste des régions la plus récente.
TransitRouterName	String	No	testname	Nom du routeur de transit Édition Entreprise. Le nom doit comporter entre 2 et 128 caractères et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_) et des traits d'union (-). Il doit commencer par une lettre et ne peut pas débuter par `http://` ou `https://`.
TransitRouterDescription	String	No	testdesc	Description du routeur de transit Édition Entreprise. La description doit comporter entre 2 et 256 caractères. Elle doit commencer par une lettre et ne peut pas débuter par `http://` ou `https://`.
DryRun	Boolean	No	false	Indique si la requête doit être vérifiée sans exécuter l'opération. Les éléments vérifiés incluent les autorisations et le statut des ressources cloud spécifiées. Valeurs possibles : false (par défaut) : envoie la requête. Si la vérification réussit, un routeur de transit Édition Entreprise est créé. true : vérifie la requête sans créer le routeur de transit Édition Entreprise. Avec cette valeur, le système vérifie si les paramètres requis sont définis et si la syntaxe de la requête est valide. En cas d'échec, un message d'erreur est renvoyé. En cas de succès, le code d'erreur `DryRunOperation` est renvoyé.
SupportMulticast	Boolean	No	false	Indique si la fonctionnalité multicast doit être activée pour le routeur de transit Édition Entreprise. Valeurs possibles : false (par défaut) : non true : oui La fonctionnalité multicast n'est prise en charge que dans certaines régions. Appelez l'opération ListTransitRouterAvailableResource pour interroger les régions qui prennent en charge le multicast.
TransitRouterCidrList	Array	No		Blocs CIDR du routeur de transit. Vous pouvez ajouter jusqu'à cinq blocs CIDR à la fois. Pour plus d'informations sur les blocs CIDR des routeurs de transit, consultez la rubrique Blocs CIDR des routeurs de transit. Remarque Seuls les routeurs de transit Édition Entreprise prennent en charge les blocs CIDR.
Cidr	String	No	192.168.10.0/24	Bloc CIDR du routeur de transit.
Name	String	No	nametest	Nom du bloc CIDR. Le nom doit comporter entre 1 et 128 caractères.
Description	String	No	desctest	Description du bloc CIDR. La description doit comporter entre 1 et 256 caractères.
PublishCidrRoute	Boolean	No	true	Indique si le système doit ajouter automatiquement une route pointant vers le bloc CIDR à la table de routage du routeur de transit. true (par défaut) : oui. Une valeur true indique qu'après la création d'une connexion VPN privée et l'activation de l'apprentissage des routes pour cette connexion, le système ajoute automatiquement une route null (blackhole) à la table de routage du routeur de transit auquel la connexion VPN est attachée. Le bloc CIDR de destination de la route null correspond au bloc CIDR du routeur de transit. Ce bloc CIDR fait référence à celui à partir duquel les adresses IP de passerelle sont allouées aux connexions IPsec-VPN. La route null est uniquement annoncée à la table de routage du routeur de bordure virtuelle (VBR) connecté au routeur de transit. false : non.
Tag.N.Key	String	No	tagtest	Clé du tag. La clé du tag ne peut pas être une chaîne vide. Elle peut comporter jusqu'à 64 caractères et ne peut pas commencer par `acs:` ou `aliyun`. Elle ne peut pas contenir `http://` ou `https://`. Vous pouvez spécifier au maximum 20 clés de tag.
Tag.N.Value	String	No	TagValue	Valeur du tag. La valeur du tag peut comporter de 0 à 128 caractères et ne peut pas commencer par `aliyun` ou `acs:`. Elle ne peut pas contenir `http://` ou `https://`. Chaque clé de tag possède une valeur de tag unique. Vous pouvez spécifier au maximum 20 valeurs de tag par appel.

Paramètres de réponse

Parameter	Type	Example	Description
TransitRouterId	String	tr-uf6llz2286805i44g****	ID du routeur de transit Édition Entreprise.
RequestId	String	404DA7EC-F495-44B5-B543-6EDCDF90F3D1	ID de la requête.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=CreateTransitRouter
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&CenId=cen-j3jzhw1zpau2km****
&RegionId=cn-zhangjiakou
&TransitRouterName=testname
&TransitRouterDescription=testdesc
&DryRun=false
&SupportMulticast=false
&TransitRouterCidrList=[{"Cidr":"192.168.10.0/24","Name":"nametest","Description":"desctest","PublishCidrRoute":true}]
&Tag=[{"Key":"tagtest","Value":"TagValue"}]
&Common request parameters

Exemple de réponse réussie

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateTransitRouterResponse>
    <TransitRouterId>tr-uf6llz2286805i44g****</TransitRouterId>
    <RequestId>404DA7EC-F495-44B5-B543-6EDCDF90F3D1</RequestId>
</CreateTransitRouterResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TransitRouterId" : "tr-uf6llz2286805i44g****",
  "RequestId" : "404DA7EC-F495-44B5-B543-6EDCDF90F3D1"
}

Codes d'erreur

HttpCode	Error codes	Error message	Description
400	InstanceExist.TransitRouterInstance	The instance already exists.	Le message d'erreur indique qu'un routeur de transit portant le même ID existe déjà dans la région actuelle. Les ID des routeurs de transit doivent être uniques au sein d'une même région.
400	Forbbiden.TransitRouterServiceNotOpen	The user has not open transit router service.	Le message d'erreur indique que le service de routeur de transit n'est pas activé. Activez le service et réessayez.
400	IllegalParam.Region	The specified region is invalid.	Le message d'erreur indique que la région spécifiée n'est pas valide.

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.