All Products
Search

This Product

    Smart Access Gateway:ModifyHealthCheck

    Document Center

    Smart Access Gateway:ModifyHealthCheck

    Last Updated:May 31, 2024

    Modifies a health check.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the Smart Access Gateway (SAG) instance.

    		cn-shanghai
    HcInstanceIdstringYes

    The ID of the health check.

    		hc-k9id4loo3lup57****
    SmartAGIdstringYes

    The ID of the SAG instance.

    		sag-i0e85k06v1mzpo****
    NamestringYes

    The name of the health check.

    The name must be 2 to 100 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

    		sss333
    DescriptionstringYes

    The description of the health check.

    The description must be 2 to 256 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

    		description
    TypestringYes

    The type of packet used in the health check. Only ICMP_ECHO is supported.

    		ICMP_ECHO
    DstIpAddrstringYes

    The destination IP address of the health check.

    		192.XX.XX.1
    DstPortintegerYes

    The destination port of the health check.

    Note This parameter is not supported.
    		2233
    SrcIpAddrstringYes

    The source IP address of the health check.

    		192.XX.XX.1
    SrcPortintegerYes

    The source port of the health check.

    Note This parameter is not supported.
    		3333
    ProbeIntervalintegerYes

    The time interval at which probes are performed. The next probe does not start before the current one is complete.

    Valid values: 1000 to 60000.

    Default value: 2000.

    Unit: milliseconds.

    		2000
    ProbeCountintegerYes

    The number of probes that are performed per health check.

    Valid values: 1 to 20.

    Default value: 1.

    		1
    ProbeTimeoutintegerYes

    The timeout period of the probe.

    Valid values: 10 to 30000.

    Default value: 3000.

    Unit: milliseconds.

    		3000
    RttThresholdintegerYes

    The maximum round-trip time (RTT).

    Valid values: -1 and 1 to 5000.

    Default value: -1. This value indicates that the RTT threshold is not specified.

    Unit: milliseconds.

    		3
    RttFailThresholdintegerYes

    The number of times that the maximum RTT is exceeded before an alert is triggered.

    Valid values: 1 to 15.

    Default value: 3.

    		3
    FailCountThresholdintegerYes

    The number of failed probes before a health check is declared failed.

    Valid values: 1 to 15.

    Default value: 3.

    		3

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		F0290F85-8087-4FB7-81F8-84226A4DAAB2

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "F0290F85-8087-4FB7-81F8-84226A4DAAB2"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400HC.InstanceNoFoundThe specified network health check instance does not exist.The specified network health check instance does not exist.
    400HC.InvalidDescriptionThe specified description is invalid.The specified description is invalid.
    400HC.InvalidDstIpAddrThe specified destination IP address is invalid.The specified destination IP address is invalid.
    400HC.InvalidDstPortThe specified destination port is invalid.The specified destination port is invalid.
    400HC.InvalidFailCountThresholdThe maximum number of successive failed probes is exceeded.The maximum number of successive failed probes is exceeded.
    400HC.InvalidNameThe specified name is invalid.The specified name is invalid.
    400HC.InvalidProbeCountThe specified number of probes is invalid.The specified number of probes is invalid.
    400HC.InvalidProbeIntervalThe specified probe interval is invalid.The specified probe interval is invalid.
    400HC.InvalidProbeTimeoutThe specified probe timeout period is invalid.The specified probe timeout period is invalid.
    400HC.InvalidRttFailThresholdThe RTT threshold has been triggered too many times.The RTT threshold has been triggered too many times.
    400HC.InvalidRttThresholdThe specified RTT is invalid.The specified RTT is invalid.
    400HC.InvalidSrcIpAddrThe specified source IP address is invalid.The specified source IP address is invalid.
    400HC.InvalidSrcPortThe specified source port is invalid.The specified source port is invalid.
    400HC.InvalidTypeThe specified type is invalid.The specified type is invalid.
    400SAG.InstanceIdEmptyYou must specify the SAG instance ID.You must specify the SAG instance ID.
    400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
    400SAG.SoftwareNotSupportFeatureThe specified SAG Software instance does not support this feature.The specified SAG Software instance does not support this feature.
    400SAG.NoActiveThe specified SAG instance has not been activated.The specified SAG instance has not been activated.
    400SAG.ArrearageThe specified SAG instance has overdue payments. Renew the instance first.The specified SAG instance has overdue payments. Renew the instance first.
    400HC.AutoGeneratedThe health check instance is automatically generated and cannot be modified.The health check instance is automatically generated and cannot be modified.
    400HC.RelatedRouteThe specified health check instance has associated routes and cannot be deleted.The specified health check instance has associated routes and cannot be deleted.

    For a list of error codes, visit the Service error codes.