调用ModifyHealthCheck修改健康检查配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyHealthCheck |
系统规定参数。取值:ModifyHealthCheck。 |
RegionId | String | 是 | cn-shanghai |
智能接入网关实例的地域ID。 |
HcInstanceId | String | 是 | hc-k9id4loo3lup57**** |
健康检查实例ID。 |
SmartAGId | String | 是 | sag-i0e85k06v1mzpo**** |
智能接入网关实例ID。 |
Name | String | 是 | sss333 |
健康检查实例名称。 长度为2~100个字符,以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)或短划线(-)。 |
Description | String | 是 | 健康检查实例1 |
健康检查实例描述。 描述长度为2~256个字符,以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)或短划线(-)。 |
Type | String | 是 | ICMP_ECHO |
健康检查的报文类型,目前仅支持ICMP_ECHO。 |
DstIpAddr | String | 是 | 192.XX.XX.1 |
健康检查的目的地址。 |
DstPort | Integer | 是 | 2233 |
健康检查的目的端口。 说明 该功能目前不支持。
|
SrcIpAddr | String | 是 | 192.XX.XX.1 |
健康检查的源地址。 |
SrcPort | Integer | 是 | 3333 |
健康检查的源端口。 说明 该功能目前不支持。
|
ProbeInterval | Integer | 是 | 2000 |
健康检查配置探测间隔,一次探测未完成情况下,不会发起下一次探测。 取值范围:1000~60000。 默认值:2000。 单位:毫秒。 |
ProbeCount | Integer | 是 | 1 |
每次健康检查探测次数。 取值范围:1~20。 默认值:1。 |
ProbeTimeout | Integer | 是 | 3000 |
健康检查一次探测的超时时间。 取值范围:10~30000。 默认值:3000。 单位:毫秒。 |
RttThreshold | Integer | 是 | 3 |
时延告警阈值。 取值范围:-1或1~5000。 默认值:-1,表示不设置时延告警阈值。 单位:毫秒。 |
RttFailThreshold | Integer | 是 | 3 |
时延阈值触发次数。 取值范围:1~15。 默认值:3。 |
FailCountThreshold | Integer | 是 | 3 |
连续探测失败数阈值。 取值范围:1~15。 默认值:3。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | F0290F85-8087-4FB7-81F8-84226A4DAAB2 |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ModifyHealthCheck
&Description=健康检查实例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
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyHealthCheckResponse>
<RequestId>F0290F85-8087-4FB7-81F8-84226A4DAAB2</RequestId>
</ModifyHealthCheckResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "F0290F85-8087-4FB7-81F8-84226A4DAAB2"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 | SAG.InstanceIdEmpty | You must specify the SAG instance ID. | 智能接入网关实例ID为空。 |
400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | 智能接入网关实例不存在。 |
400 | SAG.SoftwareNotSupportFeature | The specified SAG Software instance does not support this feature. | 智能接入网关软件版实例不支持当前特性。 |
400 | SAG.NoActive | The specified SAG instance has not been activated. | 智能接入网关实例还未激活,请先激活。 |
400 | SAG.Arrearage | The specified SAG instance has overdue payments. Renew the instance first. | 智能接入网关实例已经欠费,请先续费。 |
400 | HC.AutoGenerated | The health check instance is automatically generated and cannot be modified. | 自动编排的健康检查实例不支持修改。 |
400 | HC.RelatedRoute | The specified health check instance has associated routes and cannot be deleted. | 健康检查实例已经关联路由,无法删除。 |
访问错误中心查看更多错误码。