DescribeIngress - - Centre de documentation Alibaba Cloud

Consulte les détails d'un Ingress.

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

get

*All Resource

*

Aucune

Syntaxe de la requête

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

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
IngressId	integer	Oui	L'identifiant de la règle de routage. Appelez l'opération ListIngresses pour obtenir cet identifiant.	16263

É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	Le message renvoyé.	success
TraceId	string	L'identifiant de trace utilisé pour consulter les détails d'un appel.	0a981dd515966966104121683d****
Data	object	Les données renvoyées.
SlbId	string	L'identifiant de l'instance Server Load Balancer (SLB).	lb-uf62****6d13tq2u5
NamespaceId	string	L'identifiant de l'espace de noms.	cn-beijing:sae-test
Description	string	La description de l'Ingress.	ingress-sae-test
ListenerPort	integer	Le port d'écoute de l'instance SLB.	443
SlbType	string	Le type de l'instance SLB. Valeurs valides :	internet
CertId	string	L'identifiant du certificat Classic Load Balancer (CLB).	13623****809_16cad216b32_845_-419427029
Name	string	Le nom de l'Ingress.	lb-uf6jt0nu4z6ior943**-80-f5**
DefaultRule	object	La règle par défaut.
ContainerPort	integer	The backend port for the default rule.	8080
AppName	string	The name of the application for the default rule.	app1
AppId	string	The ID of the application for the default rule.	395b60e4-0550-458d-9c54-a265d036****
BackendProtocol	string	The backend protocol. Valid values: http: Suitable for applications that need to identify data content. https: Suitable for applications that require encrypted transmission. grpc: Suitable for load balancing gRPC services developed in multiple languages, such as .NET. This parameter is valid only when the `LoadBalanceType` parameter is set to `alb` and the `ListenerProtocol` parameter is set to `HTTPS`.	http
Rules	array<object>	Les règles de transfert.
	array<object>	Une règle de transfert.
AppName	string	The name of the destination application.	app1
ContainerPort	integer	The backend port of the application.	8080
Domain	string	The domain name of the application.	edas.site
AppId	string	The ID of the destination application.	395b60e4-0550-458d-9c54-a265d036****
Path	string	The URL path.	/path1
BackendProtocol	string	The backend protocol. Valid values: http: Suitable for applications that need to identify data content. https: Suitable for applications that require encrypted transmission. grpc: Suitable for load balancing gRPC services developed in multiple languages, such as .NET. This parameter is valid only when the `LoadBalanceType` parameter is set to `alb` and the `ListenerProtocol` parameter is set to `HTTPS`.	http
RewritePath	string	The rewritten path.	/${1}
RuleActions	array<object>	The actions of the forwarding rule.
	object	An action of the rule.
ActionType	string	The type of the action. Valid values: rewrite: a rewrite policy redirect: a redirection policy	rewrite
ActionConfig	string	The configuration of the action.	{\"host\":\"www.example.com\",\"path\":\"/example/text\",\"query\":\"x=1\"}
Id	integer	L'identifiant de l'Ingress.	87
LoadBalanceType	string	Le type de l'instance Server Load Balancer (SLB). Valeurs valides :	clb
ListenerProtocol	string	Le protocole de transfert de requête. Valeurs valides :	HTTP
CertIds	string	Les identifiants séparés par des virgules des certificats Application Load Balancer (ALB).	87*35-cn-hangzhou,812*3-cn-hangzhou
SecurityPolicyId	string	L'identifiant de l'instance de stratégie de sécurité.	sp-n0kn923****
RequestTimeout	integer	Le délai d'expiration de la requête, en secondes.	60
IdleTimeout	integer	Le délai d'inactivité de la connexion, en secondes.	3
EnableXForwardedFor	boolean	Indique si l'en-tête X-Forwarded-For doit être utilisé pour récupérer les adresses IP des clients.	true
EnableXForwardedForClientSrcPort	boolean	Indique si un en-tête doit être utilisé pour récupérer le port source du client.	true
EnableXForwardedForProto	boolean	Indique si l'en-tête X-Forwarded-Proto doit être utilisé pour récupérer le protocole d'écoute de l'instance SLB.	true
EnableXForwardedForSlbId	boolean	Indique si l'en-tête SLB-ID doit être utilisé pour récupérer l'identifiant de l'instance SLB.	true
EnableXForwardedForSlbPort	boolean	Indique si l'en-tête X-Forwarded-Port doit être utilisé pour récupérer le port d'écoute de l'instance SLB.	true
CreatedBySae	boolean	Indique si l'instance Application Load Balancer (ALB) a été provisionnée par SAE.	true
CorsConfig	object	Les configurations pour le partage de ressources cross-origin (CORS). Méthodes HTTP valides :
Enable	string	Specifies whether to enable CORS.	false
ExposeHeaders	string	The headers that are exposed to clients.	test_123
AllowHeaders	string	The headers that are allowed in cross-origin requests.	test_123
AllowMethods	string	The HTTP methods that are allowed for cross-origin requests.	GET
AllowOrigin	string	The origins that are allowed to access the resource. You can specify a single asterisk (``) or one or more specific origins. A specific origin must start with `http://` or `https://` and be a valid domain name or a first-level wildcard domain name. Example: `http://.test.abc.example.com`. You can optionally specify a port. The valid port range is 1 to 65535.	*
AllowCredentials	string	Specifies whether to allow credentials in cross-origin requests. Valid values: on: yes off: no	on
MaxAge	string	The maximum cache duration of preflight requests in the browser, in seconds. Valid values: -1 to 172800.	1000
EnableGzip	boolean	Indique si la compression Gzip doit être activée.
ErrorCode	string	Le code d'erreur.
Code	string	Le code d'état HTTP renvoyé pour la requête. Valeurs valides :	200
Success	boolean	Indique si la requête a abouti. Valeurs valides :	true

Exemples

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a981dd515966966104121683d****",
  "Data": {
    "SlbId": "lb-uf62****6d13tq2u5",
    "NamespaceId": "cn-beijing:sae-test",
    "Description": "ingress-sae-test",
    "ListenerPort": 443,
    "SlbType": "internet",
    "CertId": "13623****809_16cad216b32_845_-419427029",
    "Name": "lb-uf6jt0nu4z6ior943****-80-f5****",
    "DefaultRule": {
      "ContainerPort": 8080,
      "AppName": "app1",
      "AppId": "395b60e4-0550-458d-9c54-a265d036****",
      "BackendProtocol": "http"
    },
    "Rules": [
      {
        "AppName": "app1",
        "ContainerPort": 8080,
        "Domain": "edas.site",
        "AppId": "395b60e4-0550-458d-9c54-a265d036****",
        "Path": "/path1",
        "BackendProtocol": "http",
        "RewritePath": "/${1}",
        "RuleActions": [
          {
            "ActionType": "rewrite",
            "ActionConfig": "{\\\"host\\\":\\\"www.example.com\\\",\\\"path\\\":\\\"/example/text\\\",\\\"query\\\":\\\"x=1\\\"}"
          }
        ]
      }
    ],
    "Id": 87,
    "LoadBalanceType": "clb",
    "ListenerProtocol": "HTTP",
    "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou",
    "SecurityPolicyId": "sp-n0kn923****",
    "RequestTimeout": 60,
    "IdleTimeout": 3,
    "EnableXForwardedFor": true,
    "EnableXForwardedForClientSrcPort": true,
    "EnableXForwardedForProto": true,
    "EnableXForwardedForSlbId": true,
    "EnableXForwardedForSlbPort": true,
    "CreatedBySae": true,
    "CorsConfig": {
      "Enable": "false",
      "ExposeHeaders": "test_123",
      "AllowHeaders": "test_123",
      "AllowMethods": "GET",
      "AllowOrigin": "*",
      "AllowCredentials": "on",
      "MaxAge": "1000"
    },
    "EnableGzip": false
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s

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

Notes de version

Consultez Notes de version pour la liste complète.