更新云原生网关指定服务的健康检查策略。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mse:UpdateGatewayServiceCheck |
update |
*Gateway
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ServiceId |
string |
否 |
服务 ID |
12 |
| GatewayUniqueId |
string |
否 |
网关唯一 ID |
gw-8d410698bd7f4628ab76b*****72dd1d |
| Check |
boolean |
否 |
是否开启健康检查 |
true |
| ExpectedStatuses |
array |
否 |
正常状态码(健康检查协议为 HTTP 时必填) |
|
|
integer |
否 |
用于判断健康检查正常的 HTTP 状态码(健康检查协议为 HTTP 时必填):
|
200 |
|
| Protocol |
string |
否 |
健康检查协议,目前支持:
|
HTTP |
| Timeout |
integer |
否 |
健康检查响应超时时间(秒) |
5 |
| Interval |
integer |
否 |
健康检查间隔时间(秒) |
2 |
| HealthyThreshold |
integer |
否 |
健康检查健康阈值 |
2 |
| UnhealthyThreshold |
integer |
否 |
健康检查不健康阈值 |
2 |
| HttpPath |
string |
否 |
健康检查路径(健康检查协议为 HTTP 时必填) |
/healthz |
| HttpHost |
string |
否 |
健康检查域名(健康检查协议为 HTTP 时选填) |
example.com |
| AcceptLanguage |
string |
否 |
返回结果显示的语言。取值:zh(默认值):中文,en:英文 |
zh |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回体结构。 |
||
| RequestId |
string |
请求 ID。 |
62CBFCB8-DDC6-588C-BF1B-88828AF***** |
| HttpStatusCode |
integer |
HTTP 状态码 |
200 |
| Message |
string |
返回信息。 |
OK |
| Code |
integer |
code 仅仅用来和 success 同步。 |
200 |
| Success |
boolean |
请求结果,取值如下:true:请求成功。 false:请求失败。 |
true |
| Data |
integer |
操作的服务 ID。 |
12 |
示例
正常返回示例
JSON格式
{
"RequestId": "62CBFCB8-DDC6-588C-BF1B-88828AF*****",
"HttpStatusCode": 200,
"Message": "OK",
"Code": 200,
"Success": true,
"Data": 12
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | IllegalRequest | Invalid request:%s | 非法请求: %s |
| 400 | InvalidParameter | Parameter error:%s | 请求参数错误:%s |
| 500 | InternalError | Console error. Try again later:%s | 控制台错误.稍后重试:%s |
| 403 | NoPermission | You are not authorized to perform this operation:%s | 没有权限使用此接口:%s |
| 404 | NotFound | Not found:%s | 资源不存在:%s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。