Notificar el estado del paquete de servicio implementado
Envía un informe de estado en el paquete de servicio implementado de Service Fabric.
Notifica el estado de mantenimiento del paquete de servicio de la aplicación implementada en un nodo de Service Fabric. El informe debe contener la información sobre el origen del informe de mantenimiento y la propiedad sobre la cual se informa. El informe se envía a un servicio de puerta de enlace de Service Fabric, que lo reenvía al almacén de estado. La puerta de enlace puede aceptar el informe, pero el almacén de estado puede rechazarlo después de una validación adicional. Por ejemplo, el almacén de estado puede rechazar el informe debido a un parámetro no válido, como un número de secuencia obsoleto. Para ver si el informe se aplicó en el almacén de estado, obtenga el estado del paquete de servicio implementado y compruebe que el informe aparece en la sección HealthEvents.
Solicitud
| Método | URI de solicitud |
|---|---|
| POST | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth?api-version=6.0&Immediate={Immediate}&timeout={timeout} |
Parámetros
| Nombre | Tipo | Requerido | Location |
|---|---|---|---|
nodeName |
string | Sí | Ruta de acceso |
applicationId |
string | Sí | Ruta de acceso |
servicePackageName |
string | Sí | Ruta de acceso |
api-version |
string | Sí | Consultar |
Immediate |
boolean | No | Consultar |
timeout |
entero (int64) | No | Consultar |
HealthInformation |
HealthInformation | Sí | Body |
nodeName
Tipo: cadena
Obligatoria: sí
El nombre del nodo.
applicationId
Tipo: cadena
Obligatoria: sí
La identidad de la aplicación. Este suele ser el nombre completo de la aplicación sin el esquema de URI "fabric:"
A partir de la versión 6.0, los nombres jerárquicos se delimitan con el carácter "~".
Por ejemplo, si el nombre de la aplicación es "fabric:/myapp/app1", la identidad de la aplicación sería "myapp~app1" en 6.0+ y "myapp/app1" en las versiones anteriores.
servicePackageName
Tipo: cadena
Obligatoria: sí
El nombre del paquete de servicio.
api-version
Tipo: cadena
Obligatoria: sí
Predeterminado:
La versión de la API. Este parámetro es necesario y su valor debe ser "6.0".
La versión de la API rest de Service Fabric se basa en la versión en tiempo de ejecución en la que se introdujo o se cambió la API. El entorno de ejecución de Service Fabric admite más de una versión de la API. Esta es la versión compatible más reciente de la API. Si se pasa una versión de API inferior, la respuesta devuelta puede ser diferente de la documentada en esta especificación.
Además, el tiempo de ejecución acepta cualquier versión superior a la versión admitida más reciente hasta la versión actual del entorno de ejecución. Por lo tanto, si la versión más reciente de la API es 6.0, pero si el runtime es 6.1, para facilitar la escritura de los clientes, el entorno de ejecución aceptará la versión 6.1 para esa API. Sin embargo, el comportamiento de la API será según la versión 6.0 documentada.
Immediate
Tipo: booleano
Obligatoria: no
Predeterminado:
Una marca que indica si el informe se debe enviar inmediatamente.
Se envía un informe de mantenimiento a una aplicación de puerta de enlace de Service Fabric, que la reenvía al almacén de estado.
Si Immediate se establece en true, el informe se envía inmediatamente de la puerta de enlace HTTP al almacén de estado, independientemente de la configuración de cliente de Fabric que esté usando la aplicación de la puerta de enlace HTTP.
Esto es útil para los informes críticos que deben enviarse tan pronto como sea posible.
En función del tiempo y otras condiciones, el envío del informe puede aún generar un error, por ejemplo, si se cierra la puerta de enlace HTTP o el mensaje no llega a la puerta de enlace.
Si Immediate se establece en false, el informe se envía en función de la configuración de cliente de mantenimiento de la puerta de enlace HTTP. Por lo tanto, se procesará por lotes de acuerdo con la configuración de HealthReportSendInterval.
Esta es la configuración recomendada porque permite que el cliente de mantenimiento optimice los mensajes de notificación de estado destinados al almacén de estado, así como el procesamiento de informes de mantenimiento.
De forma predeterminada, los informes no se envían inmediatamente.
timeout
Tipo: entero (int64)
Obligatoria: no
Predeterminado:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Tiempo de espera del servidor para realizar la operación en segundos. Este tiempo de espera especifica el tiempo que el cliente está dispuesto a esperar a que se complete la operación solicitada. El valor predeterminado para este parámetro es 60 segundos.
HealthInformation
Tipo: HealthInformation
Obligatoria: sí
Describe la información de mantenimiento del informe de mantenimiento. Esta información debe estar presente en todos los informes de mantenimiento enviados al administrador de mantenimiento.
Respuestas
| Código de estado HTTP | Descripción | Esquema de respuesta |
|---|---|---|
| 200 (OK) | Una operación correcta devolverá el código de estado 200. |
|
| Todos los demás códigos de estado | Respuesta de error detallada. |
FabricError |