全部产品
Search
文档中心

负载均衡:ApplyHealthCheckTemplateToServerGroup - 应用健康检查模板到服务组

更新时间:Jun 18, 2024

将健康检查配置模板应用到后端服务器组,从而将后端服务器组的健康检查配置修改为模板值。

调试

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

授权信息

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

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

请求参数

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

模板 ID。

hct-bp1qjwo61pqz3ahltv****
ServerGroupIdstring

后端服务器组 ID。

sgp-n80wyad08u0tox****
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-42665******
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。

false

返回参数

名称类型描述示例值
object

向后端服务器组应用健康检查模板。

JobIdstring

异步任务 ID。

72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestIdstring

请求 ID。

365F4154-92F6-4AE4-92F8-7FF******

示例

正常返回示例

JSON格式

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectStatus.HealthCheckTemplateThe status of %s [%s] is incorrect.资源%s [%s]的状态无效。
400IncorrectStatus.ServerGroupThe status of %s [%s] is incorrect.服务器组状态无效。
403Forbidden.ServerGroupAuthentication has failed for ServerGroup.对ServerGroup鉴权失败
404ResourceNotFound.HealthCheckTemplateThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.ServerGroupThe specified resource %s is not found.资源%s不存在。

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

变更历史

变更时间变更内容概要操作
2024-01-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    新增错误码:403