CreateIngress - Serverless App Engine - Centro de documentación de Alibaba Cloud

Crea una regla de enrutamiento.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

sae:CreateIngress

create

*All Resource

*

Ninguna

Sintaxis de la solicitud

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

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
NamespaceId	string	Sí	El ID del espacio de nombres donde se encuentra la aplicación. No se admiten aplicaciones entre espacios de nombres.	cn-beijing:sae-test
Description	string	No	El nombre de la regla de enrutamiento.	ingress-for-sae-test
SlbId	string	No	El ID de la instancia de Server Load Balancer (SLB) asociada con la regla de enrutamiento. Nota Server Load Balancer (SLB) incluye instancias de Classic Load Balancer (CLB) y Application Load Balancer (ALB).	lb-uf6hucc7inlqrtcq5****
ListenerPort	integer	Sí	El puerto de escucha para la instancia de SLB. Este puerto debe estar disponible.	80
CertId	string	No	El ID del certificado de CLB. Si `LoadBalanceType` está configurado como `clb`, utilice este parámetro para configurar el certificado del listener HTTPS. Para obtener más información sobre cómo utilizar los ID de certificados SSL para CLB, consulte Gestionar certificados (CLB).	188077086902**_176993d_181437_108724**
CertIds	string	No	Los ID de los certificados de ALB. Si `LoadBalanceType` está configurado como `alb`, utilice este parámetro para configurar múltiples certificados para el listener HTTPS. Separe los múltiples ID de certificados con una coma (,). Obtenga el ID del certificado SSL para una instancia de ALB desde el servicio de certificados digitales. Por ejemplo, si configura `756*-cn-hangzhou`, `756*` es el ID del certificado obtenido de la página del producto y `-cn-hangzhou` es un sufijo fijo. Para obtener más información, consulte Gestionar certificados (ALB).	87*35-cn-hangzhou,812*3-cn-hangzhou
DefaultRule	string	Sí	La regla de reenvío predeterminada. Las solicitudes que no coinciden con ninguna regla de reenvío en el parámetro `Rules` se reenvían a la aplicación especificada en esta regla. El valor es una cadena JSON con los siguientes parámetros: `appId`: El ID de la aplicación. `containerPort`: El puerto de la instancia de la aplicación. Nota Esta regla sirve como captura general para el tráfico que no es manejado por otras reglas de reenvío específicas.	{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080}
Rules	string	Sí	Las reglas de reenvío. Estas reglas enrutan el tráfico a una aplicación especificada basándose en el nombre de dominio y la ruta. El valor es una cadena JSON. Cada regla contiene los siguientes parámetros: `appId`: El ID de la aplicación. `containerPort`: El puerto de la instancia de la aplicación. `domain`: El nombre de dominio. `path`: La ruta de la solicitud. `backendProtocol`: El protocolo utilizado por los servidores backend. Valores válidos: `http`, `https` y `grpc`. Valor predeterminado: `http`. `rewritePath`: La ruta reescrita. Nota Solo ALB admite la reescritura de rutas (`RewritePath`). CLB no es compatible con esta función.	[{"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	No	El tipo de instancia de Server Load Balancer (SLB). Este parámetro no se puede modificar después de crear la regla de enrutamiento. Valores válidos: `clb`: Classic Load Balancer (CLB), anteriormente conocido como SLB. `alb`: Application Load Balancer (ALB).	clb
ListenerProtocol	string	No	El protocolo de reenvío de solicitudes. Valores válidos: `HTTP`: para aplicaciones que no requieren cifrado. `HTTPS`: adecuado para aplicaciones que requieren transmisión de datos cifrada.	HTTP
SecurityPolicyId	string	No	El ID de la instancia de política de seguridad.	sp-bp1bpn0kn9****
RequestTimeout	integer	No	El tiempo de espera de la solicitud, en segundos. Valores válidos: de 1 a 180. Si un servidor backend no responde dentro del período de tiempo de espera, el load balancer deja de esperar y devuelve un error HTTP 504 al cliente.	3
IdleTimeout	integer	No	El tiempo de espera de inactividad de la conexión, en segundos. Valores válidos: de 1 a 60. Si no se recibe ninguna solicitud dentro del período de tiempo de espera, el load balancer cierra temporalmente la conexión. La conexión se restablece cuando se recibe la siguiente solicitud.	15
EnableXForwardedFor	boolean	No	Especifica si se debe utilizar el encabezado `X-Forwarded-For` para obtener la dirección IP del cliente.	true
EnableXForwardedForClientSrcPort	boolean	No	Especifica si se debe utilizar el encabezado `X-Forwarded-Port` para obtener el puerto de origen del cliente.	true
EnableXForwardedForProto	boolean	No	Especifica si se debe utilizar el encabezado `X-Forwarded-Proto` para obtener el protocolo de escucha de la instancia del load balancer.	true
EnableXForwardedForSlbId	boolean	No	Especifica si se debe utilizar el encabezado `SLB-ID` para obtener el ID de la instancia del load balancer.	true
EnableXForwardedForSlbPort	boolean	No	Especifica si se debe utilizar el encabezado `X-Forwarded-Port` para obtener el puerto de escucha de la instancia del load balancer.	true
AddressType	string	No	El tipo de dirección. Valores válidos: `Internet`: Una dirección pública. `Intranet`: Una dirección privada.	Internet
LoadBalancerEdition	string	No	La edición de la instancia de Application Load Balancer (ALB). Las diferentes ediciones tienen distintas funciones y políticas de facturación. Valores válidos: `Standard`: Edición estándar. `StandardWithWaf`: Edición mejorada con WAF.	Standard
ZoneMappings	string	No	Una cadena JSON que contiene las asignaciones entre zonas de disponibilidad y VSwitches. Si la región actual admite dos o más zonas de disponibilidad, debe especificar al menos dos. Un ZoneMapping consta de los siguientes parámetros: `VSwitchId`: una cadena que especifica el ID del VSwitch que corresponde a la zona de disponibilidad. Cada zona de disponibilidad solo puede tener un VSwitch y una subred. `ZoneId`: una cadena que especifica el ID de la zona de disponibilidad para la instancia del load balancer.	[{"VSwitchId":"vsw-wz9klui6icc08p6****","ZoneId":"cn-shenzhen-c"},{"VSwitchId":"vsw-wz9frrmoeuki2wp****","ZoneId":"cn-shenzhen-e"}]
CorsConfig	string	No	Especifica la configuración de Cross-Origin Resource Sharing (CORS).	{"Enable":"true"}
EnableGzip	boolean	No	Especifica si se debe habilitar Gzip para la compresión de datos.	true

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
RequestId	string	El ID de la solicitud.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	El mensaje devuelto. Si la solicitud es exitosa, se devuelve success. Si la solicitud falla, se devuelve un código de error.	success
TraceId	string	El ID de rastreo que se utiliza para consultar los detalles de la solicitud.	0a98a02315955564772843261e****
Data	object	Los resultados devueltos.
IngressId	integer	El ID de la regla de enrutamiento.	87
ErrorCode	string	El código de error. Este parámetro no se devuelve si la solicitud es exitosa. Este parámetro se devuelve si la solicitud falla. Para obtener más información, consulte la sección Códigos de error en este tema.
Code	string	El código de estado HTTP. Valores válidos: 2xx: La solicitud es exitosa. 3xx: La solicitud se redirige. 4xx: Se produce un error de solicitud. 5xx: Se produce un error del servidor.	200
Success	boolean	Indica si se creó la regla de enrutamiento. Valores válidos: true: La regla de enrutamiento se creó correctamente. false: No se pudo crear la regla de enrutamiento.	true

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
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
400	Slb.NotFound	The SLB instance does not exist: slbId [%s]
400	Exceed.IngressRule	The number of Ingress related rules must be less than or equal to 40.
400	SlbListenerPort.NotAvailable	The SLB listening port is unavailable: slbId [%s], port [%s]
400	SSLCert.NotFound	The specified SSL certificate cannot be found.
404	InvalidResponse.Api	The response of API %s is empty.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.