更新健康检查配置

最近更新时间: 2026-10-11 00:12:05

1. 接口描述

接口请求域名: tsf.api3.fincloud.tencent.com。

更新健康检查配置

默认接口请求频率限制:10000次/秒。

接口更新时间:2026-02-06 14:52:58。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:UpdateHealthCheckSettings
Version 是 否 String 公共参数,本接口取值:2018-03-26
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
EnableHealthCheck 否 否 Bool 是否开启健康检查
示例值: true
HealthCheckSettings 否 否 HealthCheckSettings 健康检查配置
示例值:查看
GroupId 是 否 String 部署组ID,可通过调用DescribeContainerGroups查询已创建的容器部署组列表或登录控制台进行查看;也可以调用CreateContainGroup创建新的容器部署组。
示例值: group-gyqnd7py

3. 输出参数

参数名称 类型 描述
Result Bool 更新健康检查配置操作是否成功。
true:操作成功。
false:操作失败。
示例值: true
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。

错误码 描述
ResourceNotFound.GroupNotExist 此部署组不存在,无法执行该操作。
InvalidParameter.BadRequest [%s]模块接口[%s]请求不正确(400 BAD REQUEST)。。
FailedOperation.CvmCaeMasterHealthCheckConfigError 健康检查配置失败。
MissingParameter.GroupIdNull 分组ID不能为空。

5. 示例

示例1 更新健康检查配置

输入示例

https://tsf.api3.fincloud.tencent.com/?Action=UpdateHealthCheckSettings
&GroupId=group-xxxxxxx
&EnableHealthCheck=false
&<Common Parameters>

输出示例

{
  "Response": {
    "RequestId": "0256b547-1c06-49d6-b662-39f55122xxxx",
    "Result": true
  }
}