全部产品
Search
文档中心

微服务引擎MSE:UpdateGatewayServiceCheck - 更新服务健康检查策略

更新时间:Nov 13, 2024

更新云原生网关指定服务的健康检查策略。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:UpdateGatewayServiceCheckupdate
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

请求参数

名称类型必填描述示例值
ServiceIdstring

服务 ID

12
GatewayUniqueIdstring

网关唯一 ID

gw-8d410698bd7f4628ab76b*****72dd1d
Checkboolean

是否开启健康检查

true
ExpectedStatusesarray

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

integer

用于判断健康检查正常的 HTTP 状态码(健康检查协议为 HTTP 时必填):

  • http_2xx: 200
  • http_3xx: 300
  • http_4xx: 400
  • http_5xx: 500
200
Protocolstring

健康检查协议,目前支持:

  • HTTP
  • TCP
HTTP
Timeoutinteger

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

5
Intervalinteger

健康检查间隔时间(秒)

2
HealthyThresholdinteger

健康检查健康阈值

2
UnhealthyThresholdinteger

健康检查不健康阈值

2
HttpPathstring

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

/healthz
HttpHoststring

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

example.com
AcceptLanguagestring

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

zh

返回参数

名称类型描述示例值
object

返回体结构。

RequestIdstring

请求 ID。

62CBFCB8-DDC6-588C-BF1B-88828AF*****
HttpStatusCodeinteger

HTTP 状态码

200
Messagestring

返回信息。

OK
Codeinteger

code 仅仅用来和 success 同步。

200
Successboolean

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

true
Datalong

操作的服务 ID。

12

示例

正常返回示例

JSON格式

{
  "RequestId": "62CBFCB8-DDC6-588C-BF1B-88828AF*****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": 12
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

访问错误中心查看更多错误码。