调用 CreateDirectConnectHealthCheckProbes 接口，创建健康检查探针。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：CreateDirectConnectHealthCheckProbes

接口名称。当前 API 的名称为 CreateDirectConnectHealthCheckProbes。

Version String 必选示例值：2020-04-01

接口版本。当前 API 的版本为 2020-04-01。

DirectConnectHealthCheckId String 必选示例值：dhc-2752hz4tek****

健康检查实例的ID。

您可以调用DescribeDirectConnectHealthChecks接口查询健康检查实例的ID。

Region String 必选示例值：ap-southeast-1

探针所在的地域。需与健康检查实例所在的地域相同。

DirectConnectHealthCheckProbes.N.DirectConnectHealthCheckProbeName String 可选示例值：CheckProbes-01

健康检查探针的名称。

参数 - N：表示探针的序号，单次调用数量上限10个。

多个名称之间请使用&分隔。

长度限制为1 ~ 128个字符。

需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（-）。不能以http:// 或者 https://作为开头。

不传入该参数或该参数不传入数值时，默认为健康检查探针的ID。

DirectConnectHealthCheckProbes.N.Description String 可选示例值：This is a checkprobes

健康检查探针的描述。

参数 - N：表示探针的序号，单次调用数量上限50个ID。

多个描述之间请使用&分隔。

以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。不能以http:// 或者 https://作为开头。

长度限制为1 ~ 255个字符。

不传入该参数或该参数不传入数值时，默认为空字符串。

DirectConnectHealthCheckProbes.N.ProbeTargetIp String 必选示例值：10.XX.XX.4

指定健康检查的目标IP地址，当前仅支持IPv4地址。

参数 - N：表示探针的序号，单次调用数量上限10个。

多个地址之间请使用&分隔。

DirectConnectHealthCheckProbes.N.ProbeInterval Integer 可选示例值：2

指定健康检查发送连续探测报文的时间间隔。单位：秒。默认值：2，取值范围：2~3。

参数 - N：表示探针的序号，单次调用数量上限10个。

多个报文之间请使用&分隔。

DirectConnectHealthCheckProbes.N.ProbeThreshold Integer 可选示例值：8

指定健康检查发送探测报文的个数。取值范围：3~8，默认值：8。

参数 - N：表示探针的序号，单次调用数量上限10个。

多个报文之间请使用&分隔。

DirectConnectHealthCheckProbes.N.ProbePacketProtocol String 可选示例值：ICMP

指定健康检查探测报文的协议，默认值：ICMP。

参数 - N：表示探针的序号，单次调用数量上限10个。

多个报文之间请使用&分隔。

DirectConnectHealthCheckProbes.N.ProbePort Integer 可选示例值：88

指定健康检查探测报文的端口，取值范围1～65535。

参数 - N：表示探针的序号，单次调用数量上限10个。

多个端口之间请使用&分隔。

DirectConnectHealthCheckProbes.N.ProbePacketSize Integer 可选示例值：56

指定健康检查探测报文的大小。单位：Byte。取值范围56～8500。

参数 - N：表示探针的序号，单次调用数量上限10个。

多个报文之间请使用&分隔。

ClientToken String 可选示例值：123e4567-e89b-12d3-a456-42665544****

客户端Token，用于保证请求幂等性。

由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

仅支持ASCII字符，且不能超过64个字符。

若不传入ClientToken，则此次API调用不进行幂等校验。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

DirectConnectHealthCheckProbeIds String[] 示例值：[dhp-2752hz4****]

健康检查探针的ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidDirectConnectHealthCheck.ClusterUnavailable	No available health check cluster.	没有可用的健康检查集群。
400	InvalidDirectConnectHealthCheck.InvalidStatus	The specified direct connect health check is not in the correct status for the request.	指定的健康检查所处的状态无法响应该请求。
400	InvalidDirectConnectHealthCheckProbe.CountExceeded	The specified direct connect health check probe count is invalid.	指定的健康检查探针数量过多，请分批操作，每批不超过10个。
400	InvalidDirectConnectHealthCheckProbe.Duplicated	The specified direct connect health check probe is duplicated.	指定的健康检查探针重复。
400	InvalidDirectConnectHealthCheckProbe.InvalidProbe	The specified direct connect health check probe is invalid.	指定的健康检查探针不合法。
400	InvalidDirectConnectHealthCheckProbe.InvalidTargetIP	The specified direct connect health check probe target IP is invalid.	指定的健康检查探针目标IP不合法。
400	InvalidDirectConnectHealthCheckProbe.ProbeIntervalInvalid	The specified direct connect health check probe interval is invalid.	指定的健康检查探针探测间隔不合法。
400	InvalidDirectConnectHealthCheckProbe.ProbePacketProtocolInvalid	The specified direct connect health check probe packet protocol is invalid.	指定的健康检查探针探测包协议不合法。
400	InvalidDirectConnectHealthCheckProbe.ProbePacketSizeInvalid	The specified direct connect health check probe packet size is invalid.	指定的健康检查探针探测包大小不合法。
400	InvalidDirectConnectHealthCheckProbe.ProbePortInvalid	The specified direct connect health check probe port is invalid.	指定的健康检查探针探测端口不合法。
400	InvalidDirectConnectHealthCheckProbe.ProbeThresholdInvalid	The specified direct connect health check probe threshold is invalid.	指定的健康检查探针探测阈值不合法。
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
400	QuotaExceeded.DirectConnectHealthCheckProbe	You've reached the limit on the number of probes per direct connect health check that you can create.	已达到每个健康检查可创建的探针数上限。
404	InvalidDirectConnectHealthCheck.NotFound	The specified direct connect health check does not exist.	指定的健康检查不存在。
404	InvalidDirectConnectHealthCheckCluster.NotFound	The specified direct connect direct connect health check cluster does not exist.	指定的健康检查集群不存在。

专线连接