You can call this operation to modify a health check instance.
Debugging
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | No | ModifyHealthCheck |
The operation that you want to perform. Set the value to ModifyHealthCheck. |
| Description | String | Yes | Health Check 1 |
The description of the health check instance. The description must be 2 to 256 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter or Chinese character. |
| DstIpAddr | String | Yes | 192.XX.XX.1 |
The destination IP address used in health checks. |
| DstPort | Integer | Yes | 2233 |
The destination port used in health checks. Note This feature is not supported.
|
| FailCountThreshold | Integer | Yes | 3 |
The number of failed probes before a health check is declared failed. Valid values: 1 to 15. Default value: 3. |
| HcInstanceId | String | Yes | hc-k9id4loo3lup57**** |
The ID of the health check instance. |
| Name | String | Yes | sss333 |
The name of the health check instance. The name must be 2 to 100 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter or Chinese character. |
| ProbeCount | Integer | Yes | 1 |
The number of probes preformed during each health check. Valid values: 1 to 20. Default value: 1. |
| ProbeInterval | Integer | Yes | 2000 |
The time interval at which probes are performed. The next probe does not start before the current one is completed. Valid values: 1000 to 60000. Default value: 2000. Unit: millisecond. |
| ProbeTimeout | Integer | Yes | 3000 |
The timeout period of a probe. Valid values: 10 to 30000. Default value:3000. Unit: millisecond. |
| RegionId | String | Yes | cn-shanghai |
The ID of the region where the Smart Access Gateway (SAG) instance is deployed. |
| RttFailThreshold | Integer | Yes | 3 |
The number of times that the maximum round-trip time (RTT) is exceeded before an alert is triggered. Valid values: 1 to 15. Default value: 3. |
| RttThreshold | Integer | Yes | 3 |
The maximum RTT. Valid values: -1 and 1 to 5000. Default value: -1. This value indicates that the RTT threshold is not specified. Unit: millisecond. |
| SmartAGId | String | Yes | sag-i0e85k06v1mzpo**** |
The ID of the SAG instance. |
| SrcIpAddr | String | Yes | 192.XX.XX.1 |
The source IP address used in health checks. |
| SrcPort | Integer | Yes | 3333 |
The source port used in health checks. Note This feature is not supported.
|
| Type | String | Yes | ICMP_ECHO |
The type of packet used in health checks. Only ICMP_ECHO is supported. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| RequestId | String | F0290F85-8087-4FB7-81F8-84226A4DAAB2 |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=ModifyHealthCheck
&Description=Health Check 1
&DstIpAddr=192.XX.XX.1
&DstPort=2233
&FailCountThreshold=3
&HcInstanceId=hc-k9id4loo3lup57****
&Name=sss333
&ProbeCount=1
&ProbeInterval=2000
&ProbeTimeout=3000
&RegionId=cn-shanghai
&RttFailThreshold=3
&RttThreshold=3
&SmartAGId=sag-i0e85k06v1mzpo****
&SrcIpAddr=192.XX.XX.1
&SrcPort=3333
&Type=ICMP_ECHO
&<Common request parameters>Sample success responses
XML format
<ModifyHealthCheckResponse>
<RequestId>F0290F85-8087-4FB7-81F8-84226A4DAAB2</RequestId>
</ModifyHealthCheckResponse>JSON format
{"RequestId": "F0290F85-8087-4FB7-81F8-84226A4DAAB2"}Error codes
| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | HC.InstanceNoFound | The specified network health check instance does not exist. | The error message returned because the specified health check instance does not exist. |
| 400 | HC.InvalidDescription | The specified description is invalid. | The error message returned because the specified description of the health check instance is invalid. |
| 400 | HC.InvalidDstIpAddr | The specified destination IP address is invalid. | The error message returned because the specified destination IP address is invalid. |
| 400 | HC.InvalidDstPort | The specified destination port is invalid. | The error message returned because the specified destination port is invalid. |
| 400 | HC.InvalidFailCountThreshold | The maximum number of successive failed probes is exceeded. | The error message returned because the specified number of failed probes before a health check is declared failed is invalid. |
| 400 | HC.InvalidName | The specified name is invalid. | The error message returned because the specified name of the health check instance is invalid. |
| 400 | HC.InvalidProbeCount | The specified number of probes is invalid. | The error message returned because the specified number of probes during a health check is invalid. |
| 400 | HC.InvalidProbeInterval | The specified probe interval is invalid. | The error message returned because the specified time interval at which probes are performed is invalid. |
| 400 | HC.InvalidProbeTimeout | The specified probe timeout period is invalid. | The error message returned because the specified timeout period of a probe is invalid. |
| 400 | HC.InvalidRttFailThreshold | The RTT threshold has been triggered too many times. | The error message returned because the specified number of times that the maximum RTT is exceeded before an alert is triggered is invalid. |
| 400 | HC.InvalidRttThreshold | The specified RTT is invalid. | The error message returned because the specified RTT is invalid. |
| 400 | HC.InvalidSrcIpAddr | The specified source IP address is invalid. | The error message returned because the specified source IP address is invalid. |
| 400 | HC.InvalidSrcPort | The specified source port is invalid. | The error message returned because the specified source port is invalid. |
| 400 | HC.InvalidType | The specified type is invalid. | The error message returned because the specified type of health check is invalid. |
| 400 | SAG.InstanceIdEmpty | You must specify the SAG instance ID. | The error message returned because the ID of the specified SAG instance is not specified. |
| 400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | The error message returned because the specified SAG instance does not exist. |
| 400 | SAG.SoftwareNotSupportFeature | The specified SAG Software instance does not support this feature. | The error message returned because the SAG instance does not support this feature. |
| 400 | SAG.NoActive | The specified SAG instance has not been activated. | The error message returned because the specified SAG instance has not been activated. Activate the SAG instance first. |
| 400 | SAG.Arrearage | The specified SAG instance has overdue payments. Renew the instance first. | The error message returned because the specified health check instance has an overdue payment. Complete the overdue payment first. |
| 400 | HC.AutoGenerated | The health check instance is automatically generated and cannot be modified. | The error message returned because the specified health check instance is automatically orchestrated and cannot be modified. |
| 400 | HC.RelatedRoute | The specified health check instance has associated routes and cannot be deleted. | The error message returned because the specified health check instance is already associated with a route and cannot be deleted. |
For a list of error codes, visit the API Error Center.