Creates a heath check for a Smart Access Gateway (SAG) instance.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the SAG instance. | cn-shanghai |
| SmartAGId | string | Yes | The ID of the SAG instance. | sag-1um5x5nwhilymw**** |
| Name | string | Yes | 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. | hc-123 |
| Description | string | No | 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. | hc_123 |
| Type | string | Yes | The type of packets used in the health check. Note
Only ICMP_ECHO is supported.
| ICMP_ECHO |
| DstIpAddr | string | Yes | The destination IP address of the health check. | 192.XX.XX.1 |
| DstPort | integer | No | The destination port of the health check. Note
This parameter is not supported.
| 1333 |
| SrcIpAddr | string | Yes | The source IP address of the health check. | 10.XX.XX.1 |
| SrcPort | integer | No | The source port of the health check. Note
This parameter is not supported.
| 1344 |
| ProbeInterval | integer | No | 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: milliseconds. | 2000 |
| ProbeCount | integer | No | The number of probes performed per health check. Valid values: 1 to 20. Default value: 1. | 1 |
| ProbeTimeout | integer | No | The timeout period of a probe. Valid values: 10 to 30000. Default value: 1000. Unit: milliseconds. | 1000 |
| RttThreshold | integer | No | The maximum round-trip time (RTT). Valid values: -1 and 1 to 5000. Default value: -1. This value indicates that the maximum RTT is not specified. Unit: milliseconds. | 1000 |
| RttFailThreshold | integer | No | The number of times that the maximum RTT is exceeded before an alert is triggered. Valid values: 1 to 15. Default value: 3. | 3 |
| FailCountThreshold | integer | No | The maximum number of failed probes before a health check is declared failed. Valid values: 1 to 15. Default value: 3. | 3 |
Response parameters
Examples
Sample success responses
JSONformat
{
"InstanceId": "hc-rrqoucina3gmpn****",
"RequestId": "E38E950D-28A4-4C41-9428-A8908EC6AE5C"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | HC.AutoGenerated | The health check instance is automatically generated and cannot be modified. | The health check instance is automatically generated and cannot be modified. |
| 400 | HC.InstanceNoFound | The specified network health check instance does not exist. | The specified network health check instance does not exist. |
| 400 | HC.InvalidDescription | The specified description is invalid. | The specified description is invalid. |
| 400 | HC.InvalidDstIpAddr | The specified destination IP address is invalid. | The specified destination IP address is invalid. |
| 400 | HC.InvalidDstPort | The specified destination port is invalid. | The specified destination port is invalid. |
| 400 | HC.InvalidFailCountThreshold | The maximum number of successive failed probes is exceeded. | The maximum number of successive failed probes is exceeded. |
| 400 | HC.InvalidName | The specified name is invalid. | The specified name is invalid. |
| 400 | HC.InvalidProbeCount | The specified number of probes is invalid. | The specified number of probes is invalid. |
| 400 | HC.InvalidProbeInterval | The specified probe interval is invalid. | The specified probe interval is invalid. |
| 400 | HC.InvalidProbeTimeout | The specified probe timeout period is invalid. | The specified probe timeout period is invalid. |
| 400 | HC.InvalidRttFailThreshold | The RTT threshold has been triggered too many times. | The RTT threshold has been triggered too many times. |
| 400 | HC.InvalidRttThreshold | The specified RTT is invalid. | The specified RTT is invalid. |
| 400 | HC.InvalidSrcIpAddr | The specified source IP address is invalid. | The specified source IP address is invalid. |
| 400 | HC.InvalidSrcPort | The specified source port is invalid. | The specified source port is invalid. |
| 400 | HC.InvalidType | The specified type is invalid. | The specified type is invalid. |
| 400 | HC.RelatedRoute | The specified health check instance has associated routes and cannot be deleted. | The specified health check instance has associated routes and cannot be deleted. |
| 400 | SAG.Arrearage | The specified SAG instance has overdue payments. Renew the instance first. | The specified SAG instance has overdue payments. Renew the instance first. |
| 400 | SAG.InstanceIdEmpty | You must specify the SAG instance ID. | You must specify the SAG instance ID. |
| 400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | The specified SAG instance does not exist. |
| 400 | SAG.NoActive | The specified SAG instance has not been activated. | The specified SAG instance has not been activated. |
| 400 | HC.AmountLimit | The maximum number of health check instances is exceeded. | The maximum number of health check instances is exceeded. |
| 403 | FeatureNotSupport | The current edition of the smart access gateway does not support this feature. | The current version of Smart Access Gateway does not support this feature. |
| 500 | InternalError | An error occurred while processing your request. | An error occurred while processing your request. |
For a list of error codes, visit the Service error codes.