MENU
      setServerInstanceHealth

        setServerInstanceHealth


        Article summary

        Overview

        Sets the health status of a server instance in your Auto Scaling group.

        Request

        Request parameters

        ParameterRequiredTypeLimitationsDescription
        serverInstanceNoYString-Server instance number, which is not valid if the server instance does not belong to your Auto Scaling group.
        healthStatusCodeYStringMin: 1
        Max: 5
        Health status code. The available values are HLTHY (HEALTHY) and UNHTH (UNHEALTHY).
        This parameter is available only after a server instance is created and then starts to run for your service.
        shouldRespectGracePeriodNBoolean-Indicates whether to respect the healthCheckGracePeriod. The available values are true and false.
        If the healthCheckGracePeriod does not end after a server instance is created and starts to run for your service, you cannot change the health status to unhealthy.
        Default: true

        Response

        Response body

        Examples

        Request example

        {AUTOSCALILNG_API_URL}/setServerInstanceHealth
        ?healthStatusCode=UNHTH
        &serverInstanceNo=68128
        HTTP

        Response example

        <setServerInstanceHealthResponse>
           <requestId>2785401a-14e4-42b2-9e65-0f59b29424d4</requestId>
           <returnCode>0</returnCode>
           <returnMessage>success</returnMessage>
        </setServerInstanceHealthResponse>
        XML

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.