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

Actualiza la configuración de una instancia de Ingress.

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

update

*All Resource

*

Ninguna

Sintaxis de la solicitud

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

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
IngressId	integer	Sí	El ID de la regla de enrutamiento.	87
CertId	string	No	El ID del certificado de CLB. Los detalles son los siguientes: Si LoadBalanceType es clb, utilice este campo para configurar el certificado del listener HTTPS. Para obtener más información sobre el uso de ID de certificados SSL con CLB, consulte Gestionar certificados (CLB).	188077086902**_176993d_181437_108724**
CertIds	string	No	Los ID de múltiples certificados de ALB. Los detalles son los siguientes: Si LoadBalanceType es alb, utilice este campo para configurar múltiples certificados de listener HTTPS. Separe los ID de certificados múltiples con comas. Obtenga el ID del certificado SSL utilizado por ALB desde el producto de certificados digitales. Por ejemplo, configure `756*-cn-hangzhou`, donde `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
Description	string	No	El nombre de la regla de enrutamiento.	ingress-sae-test
ListenerPort	string	No	El puerto de escucha del SLB. Este puerto no debe estar ocupado.	443
DefaultRule	string	No	La regla de reenvío predeterminada. Reenvía el tráfico a la aplicación especificada por dirección IP a través del puerto indicado. Descripción de parámetros: appId: El ID de la aplicación. containerPort: El puerto de la instancia de la aplicación. Nota Todas las solicitudes que no coincidan o no cumplan con la regla de reenvío Rules se reenvían a esta aplicación especificada.	{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080}
Rules	string	No	Las reglas de reenvío. Reenvían el tráfico a la aplicación especificada por nombre de dominio y URI de la solicitud a través del puerto indicado. Descripción de 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 URI de la solicitud.	[{"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":"/path2"}]
LoadBalanceType	string	No	Parámetro obsoleto. Ya no se admiten actualizaciones.	clb
ListenerProtocol	string	No	El protocolo de reenvío. Los detalles son los siguientes: HTTP: Aplica a aplicaciones que necesitan identificar el contenido de los datos. HTTPS: Aplica a aplicaciones que requieren transmisión cifrada.	HTTP
RequestTimeout	integer	No	El tiempo de espera de la solicitud, en segundos (s).	60
SecurityPolicyId	string	No	El ID de la instancia de política de seguridad.	tls_cipher_policy_1_2_strict_with_1_3
IdleTimeout	integer	No	El tiempo de espera de conexión inactiva, en segundos (s). Nota Un valor de 0 indica que se utiliza el tiempo de espera de inactividad predeterminado.	15
EnableXForwardedFor	boolean	No	Habilita o deshabilita la obtención de la dirección IP del cliente visitante mediante el campo de encabezado X-Forwarded-For.	true
EnableXForwardedForClientSrcPort	boolean	No	Obtiene el puerto de escucha de la instancia de SLB mediante el campo de encabezado X-Forwarded-Port.	true
EnableXForwardedForProto	boolean	No	Especifica si se debe determinar el protocolo del listener de la instancia de SLB a partir del campo de encabezado X-Forwarded-Proto.	true
EnableXForwardedForSlbId	boolean	No	Obtiene el ID de la instancia de SLB mediante el campo de encabezado SLB-ID.	true
EnableXForwardedForSlbPort	boolean	No	Especifica si se debe obtener el puerto de escucha de la instancia de Server Load Balancer a partir del campo de encabezado X-Forwarded-Port.	true
CorsConfig	string	No	La configuración entre dominios.	{\"Enable\":\"true\"}
EnableGzip	boolean	No	Habilita o deshabilita la compresión de datos.	true

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Devuelve datos.
RequestId	string	El ID de la solicitud.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	Información adicional. Los detalles son los siguientes: Si la solicitud es normal, se devuelve success. Si la solicitud es anómala, se devuelve un código de error específico.	success
TraceId	string	El ID de la cadena de llamadas.	0a98a02315955564772843261e****
Data	object	El resultado devuelto.
IngressId	integer	El ID de la regla de enrutamiento.	87
ErrorCode	string	El código de error. Los detalles son los siguientes: Si la solicitud se realiza correctamente, no se devuelve el campo ErrorCode. Si la solicitud falla, se devuelve el campo ErrorCode. Para obtener más información, consulte la lista de Códigos de error en este tema.
Code	string	El estado de la API o el código de error POP. Los detalles son los siguientes: 2xx: Éxito. 3xx: Redireccionamiento. 4xx: Error de solicitud. 5xx: Error del servidor.	200
Success	boolean	Indica si la configuración de la instancia de Ingress se actualizó correctamente. Los detalles son los siguientes: true: La actualización se realizó correctamente. false: La actualización falló.	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	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.

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.