调用CreateHealthCheck为智能接入网关实例创建健康检查。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
smartag:CreateHealthCheck |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
智能接入网关实例所属地域 ID。 |
cn-shanghai |
| SmartAGId |
string |
是 |
智能接入网关实例 ID。 |
sag-1um5x5nwhilymw**** |
| Name |
string |
是 |
健康检查实例名称。 名称长度为 2~100 个字符，以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）或短划线（-）。 |
hc-123 |
| Description |
string |
否 |
健康检查实例描述。 描述长度为 2~256 个字符，以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）或短划线（-)。 |
hc_123 |
| Type |
string |
是 |
健康检查报文类型。 说明
目前仅支持ICMP_ECHO。 |
ICMP_ECHO |
| DstIpAddr |
string |
是 |
健康检查的目的地址。 |
192.XX.XX.1 |
| DstPort |
integer |
否 |
健康检查的目的端口。 说明
该功能目前不支持。 |
1333 |
| SrcIpAddr |
string |
是 |
健康检查实例的源地址。 |
10.XX.XX.1 |
| SrcPort |
integer |
否 |
健康检查的源端口。 说明
该功能目前不支持。 |
1344 |
| ProbeInterval |
integer |
否 |
健康检查探测间隔，一次探测未完成情况下，不会发起下一次探测。 取值范围：1000~60000。 默认值：2000。 单位：毫秒。 |
2000 |
| ProbeCount |
integer |
否 |
每次健康检查探测次数。 取值范围：1~20。 默认值：1。 |
1 |
| ProbeTimeout |
integer |
否 |
一次探测的超时时间。 取值范围：10~30000。 默认值：1000。 单位：毫秒。 |
1000 |
| RttThreshold |
integer |
否 |
双向时延阈值。 取值范围：-1或 1~5000。 默认值：-1，表示不设置双向时延阈值。 单位：毫秒。 |
1000 |
| RttFailThreshold |
integer |
否 |
时延阈值触发次数。 取值范围：1~15。 默认值：3。 |
3 |
| FailCountThreshold |
integer |
否 |
连续探测失败次数阈值。 取值范围：1~15。 默认值：3。 |
3 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| InstanceId |
string |
健康检查实例 ID。 |
hc-rrqoucina3gmpn**** |
| RequestId |
string |
请求 ID。 |
E38E950D-28A4-4C41-9428-A8908EC6AE5C |
示例
正常返回示例
JSON格式
{
"InstanceId": "hc-rrqoucina3gmpn****",
"RequestId": "E38E950D-28A4-4C41-9428-A8908EC6AE5C"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | HC.AutoGenerated | The health check instance is automatically generated and cannot be modified. | 自动编排的健康检查实例不支持修改。 |
| 400 | HC.InstanceNoFound | The specified network health check instance does not exist. | 健康检查实例不存在。 |
| 400 | HC.InvalidDescription | The specified description is invalid. | 非法健康检查描述。 |
| 400 | HC.InvalidDstIpAddr | The specified destination IP address is invalid. | 非法的健康检查目标地址。 |
| 400 | HC.InvalidDstPort | The specified destination port is invalid. | 非法的健康检查目标端口 |
| 400 | HC.InvalidFailCountThreshold | The maximum number of successive failed probes is exceeded. | 非法的健康检查连续探测失败数阈值。 |
| 400 | HC.InvalidName | The specified name is invalid. | 非法的健康检查名称 |
| 400 | HC.InvalidProbeCount | The specified number of probes is invalid. | 非法的健康检查探测次数。 |
| 400 | HC.InvalidProbeInterval | The specified probe interval is invalid. | 非法的健康检查探测间隔。 |
| 400 | HC.InvalidProbeTimeout | The specified probe timeout period is invalid. | 非法的健康检查探测超时时间。 |
| 400 | HC.InvalidRttFailThreshold | The RTT threshold has been triggered too many times. | 非法的健康检查时延阈值触发次数。 |
| 400 | HC.InvalidRttThreshold | The specified RTT is invalid. | 非法的健康检查双向时延。 |
| 400 | HC.InvalidSrcIpAddr | The specified source IP address is invalid. | 非法的健康检查源地址。 |
| 400 | HC.InvalidSrcPort | The specified source port is invalid. | 非法的健康检查源端口。 |
| 400 | HC.InvalidType | The specified type is invalid. | 非法的健康检查类型。 |
| 400 | HC.RelatedRoute | 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. | 智能接入网关实例已经欠费，请先续费。 |
| 400 | SAG.InstanceIdEmpty | You must specify the SAG instance ID. | 智能接入网关实例ID为空。 |
| 400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | 智能接入网关实例不存在。 |
| 400 | SAG.NoActive | The specified SAG instance has not been activated. | 智能接入网关实例还未激活，请先激活。 |
| 400 | HC.AmountLimit | The maximum number of health check instances is exceeded. | 您创建的健康检查实例个数已经超出限额，请先提交限额申请。 |
| 500 | InternalError | An error occurred while processing your request. | 请求失败，发生未知错误。 |
| 403 | FeatureNotSupport | The current edition of the smart access gateway does not support this feature. | 智能接入网关当前版本不支持该功能特性。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。