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

Consulta os detalhes de um Ingress.

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

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
IngressId	integer	Sim	O ID da regra de roteamento. Chame a operação ListIngresses para obter este ID.	16263

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 retornada. Se a solicitação for bem-sucedida, success será retornado. Se a solicitação falhar, um código de erro específico será retornado.	success
TraceId	string	O ID de rastreamento usado para consultar os detalhes de uma chamada.	0a981dd515966966104121683d****
Data	object	Os dados retornados.
SlbId	string	O ID da instância do Server Load Balancer (SLB).	lb-uf62****6d13tq2u5
NamespaceId	string	O ID do namespace.	cn-beijing:sae-test
Description	string	A descrição do Ingress.	ingress-sae-test
ListenerPort	integer	A porta do listener da instância SLB.	443
SlbType	string	O tipo da instância SLB. Valores válidos: internet: Uma instância voltada para a internet. intranet: Uma instância voltada para a rede interna.	internet
CertId	string	O ID do certificado do Classic Load Balancer (CLB).	13623****809_16cad216b32_845_-419427029
Name	string	O nome do Ingress.	lb-uf6jt0nu4z6ior943**-80-f5**
DefaultRule	object	A regra padrão.
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>	As regras de encaminhamento.
	array<object>	Uma regra de encaminhamento.
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	O ID do Ingress.	87
LoadBalanceType	string	O tipo da instância do Server Load Balancer (SLB). Valores válidos: clb: Classic Load Balancer (CLB), anteriormente conhecido como SLB. alb: Application Load Balancer (ALB).	clb
ListenerProtocol	string	O protocolo de encaminhamento de solicitação. Valores válidos: HTTP: adequado para aplicações que precisam identificar o conteúdo dos dados. HTTPS: adequado para aplicações que requerem transmissão criptografada. Este parâmetro é opcional para as operações CreateIngress e UpdateIngress. Ele não é retornado se não tiver sido especificado quando o Ingress foi criado ou atualizado.	HTTP
CertIds	string	Os IDs separados por vírgula dos certificados do Application Load Balancer (ALB).	87*35-cn-hangzhou,812*3-cn-hangzhou
SecurityPolicyId	string	O ID da instância da política de segurança.	sp-n0kn923****
RequestTimeout	integer	O tempo limite da solicitação, em segundos. Valores válidos: 1 a 180. Valor padrão: 60. Se um servidor de backend não responder dentro do período de tempo limite especificado, o load balancer encerra a solicitação e retorna um erro HTTP 504 ao cliente.	60
IdleTimeout	integer	O tempo limite de ociosidade da conexão, em segundos. Valores válidos: 1 a 60. Valor padrão: 15. Se nenhuma solicitação for recebida dentro do período de tempo limite, o load balancer fecha a conexão. Uma nova conexão é estabelecida quando a próxima solicitação é recebida.	3
EnableXForwardedFor	boolean	Especifica se deve ser usado o cabeçalho `X-Forwarded-For` para recuperar os endereços IP do cliente.	true
EnableXForwardedForClientSrcPort	boolean	Especifica se deve ser usado um cabeçalho para recuperar a porta de origem do cliente.	true
EnableXForwardedForProto	boolean	Especifica se deve ser usado o cabeçalho `X-Forwarded-Proto` para recuperar o protocolo do listener da instância SLB.	true
EnableXForwardedForSlbId	boolean	Especifica se deve ser usado o cabeçalho `SLB-ID` para recuperar o ID da instância SLB.	true
EnableXForwardedForSlbPort	boolean	Especifica se deve ser usado o cabeçalho `X-Forwarded-Port` para recuperar a porta do listener da instância SLB.	true
CreatedBySae	boolean	Indica se a instância do Application Load Balancer (ALB) foi provisionada pelo SAE.	true
CorsConfig	object	As configurações para Cross-Origin Resource Sharing (CORS). Métodos HTTP válidos: GET POST PUT DELETE HEAD OPTIONS PATCH
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	Especifica se a compactação Gzip deve ser ativada.
ErrorCode	string	O código de erro. Este parâmetro é retornado apenas se a solicitação falhar. Para mais informações, consulte a seção Códigos de erro neste tópico.
Code	string	O código de status HTTP retornado para a solicitação. Valores válidos: 2xx: A solicitação foi bem-sucedida. 3xx: A solicitação foi redirecionada. 4xx: Ocorreu um erro de cliente. 5xx: Ocorreu um erro de servidor.	200
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "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
}

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.