创建健康检查
接口功能介绍
创建健康检查，当前仅云专线实例支持
接口约束
探测IP仅支持v4格式
URI
POST /v4/ec/health-link/create
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 是 | String | 云网关ID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| instanceID | 是 | String | 实例的UUID(当前仅支持CDA实例) | cd9a70eb-28d7-4032-9510-1bea00192f34 | |
| instanceType | 是 | Integer | 网络实例类型，取值如下: 2: CDA （目前仅支持cda） |
2 | |
| sourceIP | 是 | String | 云侧配置的探测IP，v4格式 | 172.16.10.8 | |
| destIP | 是 | String | 客户侧配置的探测IP，v4格式 | 172.16.20.1 | |
| interval | 是 | Integer | 发包时间间隔/s，取值范围：2~3，默认值：2 | 2 | |
| probeMsgCount | 是 | Integer | 探测报文数/个，取值范围：3~8，默认值：8 | 2 | |
| willSwitchRouting | 是 | Integer | 切换路由服务是否开启，取值如下: 1：切换 2：不切换 默认切换 |
2 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | 否 | Object | 返回参数 | returnObj |
请求示例
请求url
无
请求头header
无
请求体body
{
"ecID": "bb6669fd-06c1-4022-9cb4-615a90d65798",
"instanceID": "437d7519-5bde-4fc8-86ea-d403e82f7544",
"cgwID": "169b89b8-0d5f-4908-85b1-880f1fe50601",
"instanceType": 2,
"sourceIP": "172.16.10.8",
"destIP": "172.16.20.1",
"interval": 2,
"probeMsgCount": 8,
"willSwitchRouting": 1
}
响应示例
{
"description":"",
"errorCode":"",
"message":"",
"statusCode":800,
"traceID":"2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj":{}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.HealthLinkEc.CreateError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
