AddGatewayRoute - - Centre de documentation Alibaba Cloud

Ajoute une route à une passerelle.

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.

mse:AddGatewayRoute

create

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GatewayId	integer	Non	L'identifiant de la passerelle.	526
Name	string	Oui	Le nom de la route.	test
RouteOrder	integer	Non	Le numéro de séquence de la route. (Une valeur faible indique une priorité élevée.)	1
Predicates	object	Non	La règle de correspondance.
PathPredicates	object	Non	Le type de correspondance de route.
Path	string	Non	Le chemin.	/test
Type	string	Non	Le type de correspondance de route. Valeurs valides : PRE : correspondance de préfixe EQUAL : correspondance exacte ERGULAR : correspondance d'expression régulière	PRE
IgnoreCase	boolean	Non	Indique si la sensibilité à la casse doit être ignorée.	true
MethodPredicates	array	Non	Les informations sur la correspondance des méthodes.
	string	Non	La méthode.	GET
HeaderPredicates	array<object>	Non	Les informations sur la correspondance des en-têtes.
	object	Non	L'en-tête de requête.
Key	string	Non	La clé de l'en-tête de requête.	debug
Value	string	Non	La valeur correspondante.	test
Type	string	Non	Le type de correspondance.	PRE
QueryPredicates	array<object>	Non	La correspondance des paramètres d'URL.
	object	Non	Le paramètre d'URL.
Key	string	Non	Le nom du paramètre.	userid
Value	string	Non	La valeur de la condition de correspondance.	test
Type	string	Non	Le type de correspondance.	PRE
Services	array<object>	Non	Le service que vous souhaitez associer à la passerelle. Ce paramètre est requis si le paramètre Route Point est défini sur Single Service, Multiple Services ou Label routing.
	array<object>	Non	La liste des services.
ServiceId	integer	Non	L'identifiant du service.	353
Percent	integer	Non	Le poids du trafic du service d'une version spécifique, en pourcentage. Ce paramètre est requis si le paramètre Route Point est défini sur Multiple Services ou Label routing.	80
Version	string	Non	La version du service. Ce paramètre est requis uniquement si le paramètre Route Point est défini sur Label routing.	v1
Name	string	Non	Le nom.	user
SourceType	string	Non	Le type de la source.	MSE
Namespace	string	Non	L'espace de noms auquel le service appartient.	default
GroupName	string	Non	Le nom du groupe de services.	test
AgreementType	string	Non	Le type de protocole.	DUBBO
HttpDubboTranscoder	object	Non	Le convertisseur de protocole Dubbo.
DubboServiceName	string	Non	Le nom du service Dubbo.	org.apache.dubbo.samples.basic.api.DemoService
DubboServiceVersion	string	Non	La version du service Dubbo.	0.0.0
DubboServiceGroup	string	Non	Le groupe de services.	None
MothedMapList	array<object>	Non	Les règles de transfert Dubbo.
	array<object>	Non	Le mappage des méthodes.
DubboMothedName	string	Non	The Dubbo method name.	sayHello
HttpMothed	string	Non	The HTTP method. Remarque Supported HTTP method parameter values: ALL_GET. ALL_POST. ALL_PUT. ALL_DELETE. ALL_PATCH.	ALL_GET
Mothedpath	string	Non	The path that is used to match a method.	/mytestzbk/sayhello
PassThroughAllHeaders	string	Non	The pass-through type of the header. Remarque Enumeration values for pass-through types: PASS_ALL: All headers are passed through. PASS_NOT: All headers are not passed through. PASS_ASSIGN: Specified headers are passed through.	PASS_NOT
PassThroughList	array	Non	The headers that are passed through.
	string	Non	The header value that is passed through.	x-forward
ParamMapsList	array<object>	Non	The information about parameter mappings.
	object	Non	The parameter mapping object.
ExtractKeySpec	string	Non	The input parameter position. Remarque Enumeration values for input parameter positions: Request parameter: `ALL_QUERY_PARAMETER` Request header: `ALL_HEADER` URI of the request: `ALL_PATH` Request body: `ALL_BODY`	ALL_QUERY_PARAMETER
ExtractKey	string	Non	The key of the input parameter that is extracted.	name
MappingType	string	Non	The type of the backend service parameter.	java.lang.String
ServicePort	integer	Non	Le numéro de port du service.	443
DomainId	integer	Non	L'identifiant du domaine.	20
DestinationType	string	Non	Le type de service de destination. Single : Service unique Multiple : Services multiples VersionOriented : Routage par étiquette Mock : Mock Redirect : Redirection Valeurs valides : VersionOriented : VersionOriented. Multiple : Multiple. Single : Single. Redirect : Redirect. Mock : Mock.	Multiple
DirectResponseJSON	object	Non	La configuration de la réponse Mock.
Code	integer	Non	Le code de retour Mock.	403
Body	string	Non	La valeur de retour.	hello
GatewayUniqueId	string	Oui	L'identifiant unique de la passerelle.	gw-492af9b04bb4474cae9d645be8*****
DomainIdListJSON	string	Oui	Les identifiants des domaines.	[0,94]
RedirectJSON	object	Non	La configuration de l'action de redirection.
Code	integer	Non	Les codes d'état HTTP.	302
Host	string	Non	Le nom d'hôte vers lequel rediriger.	test.com
Path	string	Non	Le chemin vers lequel rediriger.	/test
EnableWaf `deprecated`	boolean	Non	Obsolète. Utilisez UpdateGatewayRouteWafStatus pour mettre à jour l'état WAF d'une route.	true
Fallback	boolean	Non	Indique si le service de repli doit être activé.	true
FallbackServices	array<object>	Non	Les services de repli.
	object	Non
ServiceId	integer	Non	L'identifiant du service.	353
Percent	integer	Non	Le poids sous forme de valeur en pourcentage.	80
Version	string	Non	La version du service.	v1
Name	string	Non	Le nom.	user
SourceType	string	Non	Le type de la source.	MSE
Namespace	string	Non	L'espace de noms dans lequel le service réside.	default
GroupName	string	Non	Le nom du groupe auquel le service appartient.	test
AgreementType	string	Non	Le type de protocole.	DUBBO
ServicePort	integer	Non	Le numéro de port du service.	443
RouteType	string	Non	Le type de route. Valeurs valides :	Op
Policies	string	Non	La stratégie de routage sous forme de chaîne JSON.	{"CORS":"{\"allowMethods\":\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\",\"allowHeaders\":\"\",\"exposeHeaders\":\"\",\"unitNum\":12,\"allowCredentials\":true,\"status\":\"off\",\"allowOrigins\":\"*\",\"timeUnit\":\"h\"}","Timeout":"{\"unitNum\":10,\"timeUnit\":\"s\",\"status\":\"off\"}","Retry":"{\"attempts\":2,\"retryOn\":[\"5xx\"],\"status\":\"off\"}","HTTPRewrite":"{\"pathType\":\"EQUAL\",\"path\":\"/o\",\"status\":\"off\"}","Waf":"{\"enabled\":false}","HeaderOp":"{\"status\":\"off\",\"headerOpItems\":[{\"directionType\":\"Request\",\"opType\":\"Add\",\"key\":\"kkk\",\"value\":\"ll\"}]}"}
Description	string	Non	La description de la route.	une route pour xxx
AcceptLanguage	string	Non	La langue de la réponse. Valeurs valides :	zh

Éléments de réponse

Élément	Type	Description	Exemple
	object	La structure de données.
RequestId	string	L'identifiant de la requête.	03A3E2F4-6804-5663-9D5D-2EC47A1*****
HttpStatusCode	integer	Le code d'état HTTP.	200
Message	string	Le message de la réponse.	La requête a été traitée avec succès
Code	integer	Le code renvoyé.	200
Success	boolean	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true
Data	integer	L'identifiant de la route.	555
ErrorCode	string	Le code d'erreur. InvalidParameter : le paramètre est invalide. Par exemple, le paramètre est incomplet ou le format du paramètre est invalide. IllegalRequest : la requête est invalide. Un accès non autorisé aux données initié par des paramètres est identifié. NoPermission : vous n'êtes pas autorisé à effectuer cette opération. NotFound : la ressource n'existe pas. InternalError : une erreur interne s'est produite.	InvalidParameter

Exemples

JSON format

{
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "HttpStatusCode": 200,
  "Message": "The request is processed successfully.",
  "Code": 200,
  "Success": true,
  "Data": 555,
  "ErrorCode": "InvalidParameter"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

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

Notes de version

Consultez Notes de version pour la liste complète.