CreateHealthCheck_智能接入网关_API文档-阿里云OpenAPI开发者门户

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

smartag:CreateHealthCheck	Create	全部资源 *	无	无

请求参数

字段名称	字段详情
RegionIdstring	智能接入网关实例所属地域 ID。示例值:cn-shanghai参考取值来源: DescribeRegions
SmartAGIdstring	智能接入网关实例 ID。示例值:sag-1um5x5nwhilymw****参考取值来源: AddSnatEntry BindSmartAccessGateway CreateSmartAccessGateway ListSmartAGByAccessPoint
Namestring	健康检查实例名称。展开详情示例值:hc-123
Descriptionstring	健康检查实例描述。展开详情示例值:hc_123
Typestring	健康检查报文类型。展开详情示例值:ICMP_ECHO
DstIpAddrstring	健康检查的目的地址。示例值:192.XX.XX.1
DstPortinteger<int32>	健康检查的目的端口。展开详情示例值:1333
SrcIpAddrstring	健康检查实例的源地址。示例值:10.XX.XX.1
SrcPortinteger<int32>	健康检查的源端口。展开详情示例值:1344
ProbeIntervalinteger<int32>	健康检查探测间隔，一次探测未完成情况下，不会发起下一次探测。展开详情示例值:2000取值 <= 60000
ProbeCountinteger<int32>	每次健康检查探测次数。展开详情示例值:1取值 <= 20
ProbeTimeoutinteger<int32>	一次探测的超时时间。展开详情示例值:1000取值 <= 30000
RttThresholdinteger<int32>	双向时延阈值。展开详情示例值:1000
RttFailThresholdinteger<int32>	时延阈值触发次数。展开详情示例值:3取值 <= 15
FailCountThresholdinteger<int32>	连续探测失败次数阈值。展开详情示例值:3取值 <= 15

返回参数

字段名称	字段详情
InstanceIdstring	健康检查实例 ID。示例值:hc-rrqoucina3gmpn****
RequestIdstring	请求 ID。示例值:E38E950D-28A4-4C41-9428-A8908EC6AE5C

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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.	诊断
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.	诊断
403	FeatureNotSupport	The current edition of the smart access gateway does not support this feature.	诊断
500	InternalError	An error occurred while processing your request.	诊断

变更历史

暂无变更历史

CreateHealthCheck_智能接入网关_API文档

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例