UpdateGatewayServiceCheck_微服务引擎_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为100/1(s)。

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
mse:UpdateGatewayServiceCheck
Update
Gateway
acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

请求参数

字段名称字段详情
ServiceIdstring

服务 ID

示例值:12参考取值来源:
    AddGatewayServiceVersion
GatewayUniqueIdstring

网关唯一 ID

示例值:gw-8d410698bd7f4628ab76b*****72dd1d参考取值来源:
    UpdateGatewayIsolationRule
    AddGatewayRoute
    ListGateway
    CreateGatewayIsolationRule
    GetGatewayAuthDetail
    GatewayBlackWhiteList
Checkboolean

是否开启健康检查

示例值:true
ExpectedStatusesarray<integer<int32>>

正常状态码(健康检查协议为 HTTP 时必填)

Protocolstring

健康检查协议,目前支持:展开详情

示例值:HTTP
Timeoutinteger<int32>

健康检查响应超时时间(秒)

示例值:5
Intervalinteger<int32>

健康检查间隔时间(秒)

示例值:2
HealthyThresholdinteger<int32>

健康检查健康阈值

示例值:2
UnhealthyThresholdinteger<int32>

健康检查不健康阈值

示例值:2
HttpPathstring

健康检查路径(健康检查协议为 HTTP 时必填)

示例值:/healthz
HttpHoststring

健康检查域名(健康检查协议为 HTTP 时选填)

示例值:example.com
AcceptLanguagestring

返回结果显示的语言。取值:zh(默认值):中文,en:英文

示例值:zh

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:62CBFCB8-DDC6-588C-BF1B-88828AF*****
HttpStatusCodeinteger<int32>

HTTP 状态码

示例值:200
Messagestring

返回信息。

示例值:OK
Codeinteger<int32>

code 仅仅用来和 success 同步。

示例值:200
Successboolean

请求结果,取值如下:true:请求成功。 false:请求失败。

示例值:true
Datainteger<int64>

操作的服务 ID。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:12

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
IllegalRequest
Invalid request:%s诊断
400
InvalidParameter
Parameter error:%s诊断
403
NoPermission
You are not authorized to perform this operation:%s诊断
404
NotFound
Not found:%s诊断
500
InternalError
Console error. Try again later:%s诊断

变更历史

暂无变更历史

相关示例