更新云原生网关指定服务的健康检查策略。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
 - 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
 - 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
 - 对于不支持资源级授权的操作,用
全部资源表示。 
 - 条件关键字:是指云产品自身定义的条件关键字。
 - 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
 
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| mse:UpdateGatewayServiceCheck | update | *Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId} | 
  | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| 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 | 
返回参数
示例
正常返回示例
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 | 
| 403 | NoPermission | You are not authorized to perform this operation:%s | 没有权限使用此接口:%s | 
| 404 | NotFound | Not found:%s | 资源不存在:%s | 
| 500 | InternalError | Console error. Try again later:%s | 控制台错误.稍后重试:%s | 
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|
暂无变更历史
