CreateIngress - - Centre de documentation Alibaba Cloud

Crée une règle de routage.

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.

sae:CreateIngress

create

*Toutes les ressources.

*

Aucune

Syntaxe de la requête

POST /pop/v1/sam/ingress/Ingress HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
NamespaceId	string	Oui	L'identifiant de l'espace de noms où réside l'application. Les applications inter-espaces de noms ne sont pas prises en charge.	cn-beijing:sae-test
Description	string	Non	Le nom de la règle de routage.	ingress-for-sae-test
SlbId	string	Non	L'identifiant de l'instance SLB utilisée par la règle de routage. Remarque Server Load Balancer (SLB) inclut les instances CLB et ALB.	lb-uf6hucc7inlqrtcq5****
ListenerPort	integer	Oui	Le port d'écoute de l'instance SLB. Le port ne doit pas être occupé.	80
CertId	string	Non	L'identifiant du certificat CLB. Valeurs valides : Si LoadBalanceType est défini sur clb, utilisez ce champ pour configurer le certificat pour l'écouteur HTTPS. Pour plus d'informations sur l'utilisation des identifiants de certificats SSL dans CLB, consultez Gérer les certificats (CLB).	188077086902**_176993d_181437_108724**
CertIds	string	Non	Les identifiants des certificats ALB. Valeurs valides : Si LoadBalanceType est défini sur alb, utilisez ce champ pour configurer plusieurs certificats pour l'écouteur HTTPS. Séparez les identifiants de certificats multiples par des virgules (,). Vous devez obtenir les identifiants de certificats SSL utilisés par ALB auprès du service de gestion des certificats. Par exemple, si vous configurez 756*-cn-hangzhou, 756* est l'identifiant du certificat obtenu à partir de la page du produit, et -cn-hangzhou est un suffixe fixe. Pour plus d'informations, consultez Gérer les certificats (ALB).	87*35-cn-hangzhou,812*3-cn-hangzhou
DefaultRule	string	Oui	La règle de transfert par défaut. Le trafic est transféré vers l'application spécifiée en fonction de l'adresse IP via le port spécifié. Les paramètres sont les suivants : appId : l'identifiant de l'application. containerPort : le port de l'instance d'application. Remarque Toutes les requêtes qui ne correspondent pas ou ne satisfont pas aux règles de transfert dans Rules sont transférées vers l'application spécifiée.	{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080}
Rules	string	Oui	Les règles de transfert. Le trafic est transféré vers l'application spécifiée en fonction du nom de domaine et du chemin de la requête via le port spécifié. Les paramètres sont les suivants : appId : l'identifiant de l'application. containerPort : le port de l'instance d'application. domain : le nom de domaine. path : l'URI de la requête. backendProtocol : le protocole du service backend. Valeurs valides : http, https et grpc. Valeur par défaut : http. rewritePath : le chemin de réécriture. Remarque Actuellement, seul ALB prend en charge la fonctionnalité de réécriture de chemin d'URL (RewritePath). CLB ne prend pas en charge cette fonctionnalité.	[{"appId":"395b60e4-0550-458d-9c54-a265d036**","containerPort":8080,"domain":"www.sae.site","path":"/path1"},{"appId":"666403ce-d25b-47cf-87fe-497565d2*","containerPort":8080,"domain":"sae.site","path":"/sys/(.)/(.*)/aaa","backendProtocol":"http"}]
LoadBalanceType	string	Non	Le type d'instance SLB. Le type dépend de la valeur spécifiée lors de la création de la règle de routage et ne peut pas être modifié lors des mises à jour. Valeurs valides : clb : Classic Load Balancer (CLB). alb : Application Load Balancer (ALB).	clb
ListenerProtocol	string	Non	Le protocole de transfert des requêtes. Valeurs valides : HTTP : applicable aux applications qui ont besoin d'identifier le contenu des données. HTTPS : applicable aux applications qui nécessitent une transmission chiffrée.	HTTP
SecurityPolicyId	string	Non	L'identifiant de l'instance de stratégie de sécurité.	sp-bp1bpn0kn9****
RequestTimeout	integer	Non	Spécifie le délai d'expiration de la requête. Unité : secondes. Valeurs valides : 1 à 180. Si le serveur backend n'envoie pas de réponse dans le délai d'expiration, l'équilibrage de charge cesse d'attendre et renvoie un code d'erreur HTTP 504 au client.	3
IdleTimeout	integer	Non	Spécifie le délai d'inactivité de la connexion. Unité : secondes. Valeurs valides : 1 à 60. Si aucune requête d'accès n'est reçue dans le délai d'expiration, l'équilibrage de charge interrompt temporairement la connexion actuelle jusqu'à ce qu'une nouvelle connexion soit établie à l'arrivée de la requête suivante.	15
EnableXForwardedFor	boolean	Non	Indique si la fonctionnalité permettant d'obtenir l'adresse IP client du visiteur via le champ d'en-tête X-Forwarded-For doit être activée.	true
EnableXForwardedForClientSrcPort	boolean	Non	Indique si le port d'écoute de l'instance d'équilibrage de charge doit être obtenu via le champ d'en-tête X-Forwarded-Port.	true
EnableXForwardedForProto	boolean	Non	Indique si le protocole d'écoute de l'instance d'équilibrage de charge doit être obtenu via le champ d'en-tête X-Forwarded-Proto.	true
EnableXForwardedForSlbId	boolean	Non	Indique si l'identifiant de l'instance d'équilibrage de charge doit être obtenu via le champ d'en-tête SLB-ID.	true
EnableXForwardedForSlbPort	boolean	Non	Indique si le port d'écoute de l'instance d'équilibrage de charge doit être obtenu via le champ d'en-tête X-Forwarded-Port.	true
AddressType	string	Non	Le type d'adresse. Valeurs valides : Internet : adresse de réseau public. Intranet : adresse de réseau privé.	Internet
LoadBalancerEdition	string	Non	L'édition de l'Application Load Balancer (ALB). Les différentes éditions ont des limites de fonctionnalités et des politiques de facturation différentes. Valeurs valides : Standard : Édition standard. StandardWithWaf : Édition améliorée avec WAF.	Standard
ZoneMappings	string	Non	La chaîne JSON de la liste de mappage des zones et des vSwitch. Si la région actuelle prend en charge deux zones ou plus, vous devez ajouter au moins deux zones. Une structure ZoneMapping comprend : VSwitchId : le vSwitch correspondant à la zone. Type de données : String. Un seul vSwitch et un seul sous-réseau peuvent être utilisés dans chaque zone. ZoneId : l'identifiant de zone de l'instance Network Load Balancer (NLB). Type de données : String.	[{"VSwitchId":"vsw-wz9klui6icc08p6****","ZoneId":"cn-shenzhen-c"},{"VSwitchId":"vsw-wz9frrmoeuki2wp****","ZoneId":"cn-shenzhen-e"}]
CorsConfig	string	Non	La configuration du partage de ressources cross-origin (CORS).	{"Enable":"true"}
EnableGzip	boolean	Non	Indique si la compression des données doit être activée.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
RequestId	string	L'identifiant de la requête.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	Les informations supplémentaires. Valeurs valides : Si la requête est normale, success est renvoyé. Si la requête est anormale, un code d'erreur spécifique est renvoyé.	success
TraceId	string	L'identifiant de trace, qui est utilisé pour interroger avec précision les informations d'appel.	0a98a02315955564772843261e****
Data	object	Le résultat renvoyé.
IngressId	integer	L'identifiant de la règle de routage.	87
ErrorCode	string	Le code d'erreur. Valeurs valides : Si la requête aboutit, le champ ErrorCode n'est pas renvoyé. Si la requête échoue, le champ ErrorCode est renvoyé. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.	InvalidParameter.NotEmpty
Code	string	Le code d'état de l'API ou le code d'erreur POP. Valeurs valides : 2xx : succès. 3xx : redirigé. 4xx : erreur de requête. 5xx : erreur de serveur.	200
Success	boolean	Indique si la règle de routage a été créée avec succès. Valeurs valides : true : créée avec succès. false : échec de la création.	true

Exemples

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "IngressId": 87
  },
  "ErrorCode": "InvalidParameter.NotEmpty",
  "Code": "200",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	Paramètre non valide : %s ne peut pas être vide.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	Paramètre non valide {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	Paramètre non valide {%s} : %s.
400	Slb.NotFound	The SLB instance does not exist: slbId [%s]	L'instance SLB n'existe pas : slbId[%s].
400	Exceed.IngressRule	The number of Ingress related rules must be less than or equal to 40.	Le nombre de règles pour la configuration de l'Ingress ne peut pas dépasser 40.
400	SlbListenerPort.NotAvailable	The SLB listening port is unavailable: slbId [%s], port [%s]	Le port d'écoute SLB est occupé : slbId[%s], port[%s].
400	SSLCert.NotFound	The specified SSL certificate cannot be found.	Le certificat SSL correspondant est introuvable.
404	InvalidResponse.Api	The response of API %s is empty.	L'API a renvoyé des données vides.

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

Notes de version

Consultez Notes de version pour la liste complète.