ListIngresses - - Centre de documentation Alibaba Cloud

Consulte la liste des 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:ListIngresses

get

*Toutes les ressources.

*

Aucune

Syntaxe de la requête

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

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
NamespaceId	string	Oui	L'identifiant de l'espace de noms.	cn-beijing
AppId	string	Non	L'identifiant de l'application.	bbf3a590-6d13-46fe-8ca9-c947a20b****
CurrentPage	integer	Non	Le numéro de page actuel.	1
PageSize	integer	Non	Le nombre d'entrées par page.	20

É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. La valeur est décrite comme suit : Si la requête réussit, success est renvoyé. Si la requête échoue, le code d'erreur spécifique est renvoyé.	success
TraceId	string	L'identifiant de trace utilisé pour interroger les informations d'appel.	0a98a02315955564772843261e****
Data	object	Les résultats renvoyés.
CurrentPage	integer	Le numéro de page actuel.	1
TotalSize	integer	Le nombre total d'entrées interrogées.	10
PageSize	integer	Le nombre d'entrées par page.	10
IngressList	array<object>	La liste des règles de routage.
	array<object>	Les informations sur la règle de routage.
SlbId	string	L'identifiant du SLB.	lb-uf62****6d13tq2u5
NamespaceId	string	L'identifiant de l'espace de noms.	cn-shanghai
Description	string	Le nom de la règle de routage.	test
ListenerPort	string	Le port d'écoute du SLB.	80
SlbType	string	Le type de SLB. Valeurs valides : internet : Internet. intranet : Réseau interne.	internet
CertId	string	L'identifiant du certificat CLB.	13624***73809_16f8e549a20_1175189789_12**3210
CertIds	string	Les identifiants des certificats ALB.	87*35-cn-hangzhou,812*3-cn-hangzhou
Name	string	Le nom de la règle de routage.	lb-uf6jt0nu4z6ior943**-80-f5**
Id	integer	L'identifiant de la règle de routage.	18
LoadBalanceType	string	Le type de l'équilibreur de charge SLB. Valeurs valides : clb : Équilibreur de charge classique (CLB), anciennement connu sous le nom de SLB. alb : Équilibreur de charge d'application (ALB).	clb
ListenerProtocol	string	Le protocole de transfert de requêtes pris en charge par l'équilibreur de charge SLB. Valeurs valides :\n\n- HTTP : Applicable aux applications qui ont besoin d'identifier le contenu des données.\n- HTTPS : Applicable aux applications qui nécessitent une transmission chiffrée.\n\nCe paramètre est facultatif dans CreateIngress et UpdateIngress. Si vous ne spécifiez pas ce paramètre lors de la création ou de la mise à jour d'une règle de routage de passerelle, ce paramètre n'est pas renvoyé lorsque vous appelez cette API.	HTTP
MseGatewayId	string	L'identifiant de l'instance de passerelle cloud-native MSE.	gw-d5df01a1bae748f1a7c4e325d2fd****
MseGatewayPort	string	Le port correspondant au service.	80
MseGatewayProtocol	string	Le protocole de transfert de requêtes pris en charge par la passerelle cloud-native MSE. Valeurs valides : HTTP : Applicable aux applications nécessitant l'identification du contenu des données. HTTPS : Applicable aux applications nécessitant une transmission chiffrée.	HTTP
RequestTimeout	integer	Le délai d'expiration de la requête.	60
IdleTimeout	integer	Le délai d'expiration des connexions inactives.	3
CreateTime	integer	L'heure de création.	1593746835111
DefaultRule	object	La règle par défaut.
ContainerPort	integer	Le port du conteneur.	8080
AppName	string	Le nom de l'application.	demo-app
AppId	string	L'identifiant de l'application.	7171a6ca-d1cd-4928-8642-7d5cfe69****
BackendProtocol	string	Le protocole backend.	http
Rules	array<object>	Les règles.
	array<object>
AppName	string	Le nom de l'application.	demo-app
ContainerPort	integer	Le port du conteneur.	8080
Domain	string	Le nom de domaine.	edas.site
AppId	string	L'identifiant de l'application.	7171a6ca-d1cd-4928-8642-7d5cfe69****
Path	string	Le chemin d'accès.	/Path
BackendProtocol	string	Le protocole backend.	http
RewritePath	string	Le chemin de réécriture.	/${1}
RuleActions	array<object>	La liste des actions de règle.
	object	L'action de règle.
ActionType	string	Le type d'action.	rewrite
ActionConfig	string	La configuration de l'action.	{\"host\":\"www.example.com\",\"path\":\"/example/text\",\"query\":\"x=1\"}
CorsConfig	object	La configuration CORS.
Enable	string	Indique si la fonctionnalité est activée.	false
ExposeHeaders	string	Les en-têtes exposés autorisés.	test_123
AllowHeaders	string	Les en-têtes autorisés.	test_123
AllowMethods	string	Les méthodes autorisées.	GET
AllowOrigin	string	Les origines autorisées.	*
AllowCredentials	string	Indique si les informations d'identification sont autorisées.	on
MaxAge	string	La durée de vie maximale.	1000
ErrorCode	string	Le code d'erreur. Valeurs valides : Si la requête aboutit, le paramètre ErrorCode n'est pas renvoyé. Si la requête échoue, le paramètre 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 : Redirection. 4xx : Erreur de requête. 5xx : Erreur de serveur.	200
Success	boolean	Indique si la liste des ingress a été récupérée avec succès. Valeurs valides : true : la liste des ingress a été récupérée avec succès. false : la récupération de la liste des ingress a échoué.	true

Exemples

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 10,
    "PageSize": 10,
    "IngressList": [
      {
        "SlbId": "lb-uf62****6d13tq2u5",
        "NamespaceId": "cn-shanghai",
        "Description": "test",
        "ListenerPort": "80",
        "SlbType": "internet",
        "CertId": "13624*****73809_16f8e549a20_1175189789_12****3210",
        "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou",
        "Name": "lb-uf6jt0nu4z6ior943****-80-f5****",
        "Id": 18,
        "LoadBalanceType": "clb",
        "ListenerProtocol": "HTTP",
        "MseGatewayId": "gw-d5df01a1bae748f1a7c4e325d2fd****",
        "MseGatewayPort": "80",
        "MseGatewayProtocol": "HTTP",
        "RequestTimeout": 60,
        "IdleTimeout": 3,
        "CreateTime": 1593746835111,
        "DefaultRule": {
          "ContainerPort": 8080,
          "AppName": "demo-app",
          "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
          "BackendProtocol": "http"
        },
        "Rules": [
          {
            "AppName": "demo-app",
            "ContainerPort": 8080,
            "Domain": "edas.site",
            "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
            "Path": "/Path",
            "BackendProtocol": "http",
            "RewritePath": "/${1}",
            "RuleActions": [
              {
                "ActionType": "rewrite",
                "ActionConfig": "{\\\"host\\\":\\\"www.example.com\\\",\\\"path\\\":\\\"/example/text\\\",\\\"query\\\":\\\"x=1\\\"}"
              }
            ]
          }
        ],
        "CorsConfig": {
          "Enable": "false",
          "ExposeHeaders": "test_123",
          "AllowHeaders": "test_123",
          "AllowMethods": "GET",
          "AllowOrigin": "*",
          "AllowCredentials": "on",
          "MaxAge": "1000"
        }
      }
    ]
  },
  "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.

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

Notes de version

Consultez Notes de version pour la liste complète.