ListIngresses - Serverless App Engine: Central de Documentação do Alibaba Cloud

Obtém uma lista de Ingresses.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

sae:ListIngresses

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NamespaceId	string	Sim	O ID do namespace.	cn-beijing
AppId	string	Não	O ID da aplicação.	bbf3a590-6d13-46fe-8ca9-c947a20b****
CurrentPage	integer	Não	O número da página atual.
PageSize	integer	Não	O tamanho da página.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	A mensagem de resposta. success é retornado se a chamada for bem-sucedida. Um código de erro é retornado se a chamada falhar.	success
TraceId	string	O ID de rastreamento. Você pode usá-lo para consultar os detalhes de uma chamada.	0a98a02315955564772843261e****
Data	object	O resultado.
CurrentPage	integer	A página atual.
TotalSize	integer	O número total de entradas encontradas.
PageSize	integer	O número de entradas por página.
IngressList	array<object>	A lista de regras de roteamento.
	array<object>	As informações sobre a regra de roteamento.
SlbId	string	The ID of the Server Load Balancer (SLB) instance.	lb-uf62****6d13tq2u5
NamespaceId	string	The namespace ID.	cn-shanghai
Description	string	The name of the Ingress rule.	test
ListenerPort	string	The listening port of the SLB instance.	80
SlbType	string	The type of the SLB instance. Valid values: internet: public network. intranet: private network.	internet
CertId	string	The ID of the Classic Load Balancer (CLB) certificate.	13624***73809_16f8e549a20_1175189789_12**3210
CertIds	string	The IDs of the Application Load Balancer (ALB) certificates.	87*35-cn-hangzhou,812*3-cn-hangzhou
Name	string	The name of the routing rule.	lb-uf6jt0nu4z6ior943**-80-f5**
Id	integer	The ID of the routing rule.	18
LoadBalanceType	string	The type of the SLB instance. Valid values: clb: Classic Load Balancer. alb: Application Load Balancer.	clb
ListenerProtocol	string	The forwarding protocol of the SLB instance. Valid values: HTTP: suitable for applications that need to identify data content. HTTPS: suitable for applications that require encrypted transmission. This parameter is optional for the CreateIngress and UpdateIngress operations. If you do not set this parameter when you create or update a gateway routing rule, this parameter is not returned.	HTTP
MseGatewayId	string	The ID of the MSE cloud-native gateway instance.	gw-d5df01a1bae748f1a7c4e325d2fd****
MseGatewayPort	string	The port that corresponds to the service.	80
MseGatewayProtocol	string	The forwarding protocol supported by the MSE cloud-native gateway. Valid values: HTTP: suitable for applications that need to identify data content. HTTPS: suitable for applications that require encrypted transmission.	HTTP
RequestTimeout	integer	The request timeout period.
IdleTimeout	integer	The connection idle timeout period.
CreateTime	integer	The creation time.
DefaultRule	object	The default rule.
ContainerPort	integer	The container port.
AppName	string	The application name.
AppId	string	The application ID.
BackendProtocol	string	The backend protocol.
Rules	array<object>	The rules.
	array<object>
AppName	string	The application name.
ContainerPort	integer	The container port.
Domain	string	The domain name.
AppId	string	The application ID.
Path	string	The path.
BackendProtocol	string	The backend protocol.
RewritePath	string	The rewritten path.
RuleActions	array<object>	The list of rule actions.
	object	The rule action.
ActionType	string	The action type.
ActionConfig	string	The action configuration.
CorsConfig	object	The cross-domain configuration.
Enable	string	Indicates whether cross-domain access is enabled.
ExposeHeaders	string	The allowed exposed headers.
AllowHeaders	string	The allowed headers.
AllowMethods	string	The allowed methods.
AllowOrigin	string	The allowed origins.
AllowCredentials	string	Indicates whether credentials can be carried.
MaxAge	string	The time-to-live (TTL).
ErrorCode	string	O código de erro. Este parâmetro não é retornado se a solicitação for bem-sucedida. Este parâmetro é retornado se a solicitação falhar. Para obter mais informações, consulte a seção Códigos de erro deste tópico.
Code	string	O status da chamada de API ou um código de erro POP. Valores válidos: 2xx: A chamada foi bem-sucedida. 3xx: A chamada foi redirecionada. 4xx: Ocorreu um erro de cliente. 5xx: Ocorreu um erro de servidor.	200
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 0,
    "TotalSize": 0,
    "PageSize": 0,
    "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": 0,
        "IdleTimeout": 0,
        "CreateTime": 0,
        "DefaultRule": {
          "ContainerPort": 0,
          "AppName": "",
          "AppId": "",
          "BackendProtocol": ""
        },
        "Rules": [
          {
            "AppName": "",
            "ContainerPort": 0,
            "Domain": "",
            "AppId": "",
            "Path": "",
            "BackendProtocol": "",
            "RewritePath": "",
            "RuleActions": [
              {
                "ActionType": "",
                "ActionConfig": ""
              }
            ]
          }
        ],
        "CorsConfig": {
          "Enable": "",
          "ExposeHeaders": "",
          "AllowHeaders": "",
          "AllowMethods": "",
          "AllowOrigin": "",
          "AllowCredentials": "",
          "MaxAge": ""
        }
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
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

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.