在指定地域创建健康检查模板。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alb:CreateHealthCheckTemplate | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 5A2CFF0E-5718-45B5-9D4D-70B****** |
HealthCheckTemplateName | string | 是 | 健康检查模板名称。 长度为 2~128 个英文或中文字符,必须以大小写英文字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。 | HealthCheckTemplate1 |
HealthCheckConnectPort | integer | 否 | 健康检查使用的端口。 取值范围:0~65535。 默认值:0,表示使用后端服务器的端口进行健康检查。 | 80 |
HealthCheckHost | string | 否 | 用于健康检查的域名。取值:
说明
只有 HealthCheckProtocol 设置为 HTTP 或 HTTPS 时该参数生效。
| $SERVER_IP |
HealthCheckCodes | array | 否 | 健康检查正常的状态码列表。 | |
string | 否 | 健康检查正常的 HTTP 状态码。
说明
只有 HealthCheckProtocol 为 HTTP 或 HTTPS 或 gRPC 时才有该参数。
| http_2xx | |
HealthCheckInterval | integer | 否 | 健康检查的时间间隔。 取值范围:1~50秒。 默认值:2 秒。 | 2 |
HealthCheckTimeout | integer | 否 | 接收来自运行状况检查的响应需要等待的时间。如果后端服务器在指定的时间内没有正确响应,则判定为健康检查失败。 取值范围:1~300秒。 默认值:5 秒。 | 5 |
HealthCheckPath | string | 否 | 用于健康检查的 URL。 长度限制为 1~80,支持使用字母、数字和短划线(-)、正斜线(/)、半角句号(.)、百分号(%)、半角问号(?)、井号(#)和 and(&)以及扩展字符集 说明
只有 HealthCheckProtocol 为 HTTP 或 HTTPS 时才有该参数。
| /test/index.html |
HealthCheckMethod | string | 否 | 健康检查方法。取值:
说明
只有 HealthCheckProtocol 为 HTTP 或 HTTPS 或 gRPC 时才有该参数。
| HEAD |
HealthCheckProtocol | string | 否 | 健康检查采用的协议。取值:
| HTTP |
HealthCheckHttpVersion | string | 否 | 健康检查 HTTP 协议版本。 取值:HTTP 1.0或HTTP 1.1。 默认值:HTTP 1.1。 说明
只有 HealthCheckProtocol 为 HTTP 或 HTTPS 时才有该参数。
| HTTP 1.0 |
HealthyThreshold | integer | 否 | 健康检查连续成功多少次后,将后端服务器的健康检查状态由失败判定为成功。 取值范围:2~10。 默认值:3。 | 4 |
UnhealthyThreshold | integer | 否 | 健康检查连续失败多少次后,将后端服务器的健康检查状态由成功判定为失败。 取值范围:2~10。 默认值:3。 | 4 |
DryRun | boolean | 否 | 是否只预检此次请求,取值:
| true |
Tag | array<object> | 否 | 标签。 | |
object | 否 | 标签结构。 | ||
Key | string | 否 | 标签键。最多支持 128 个字符,不能以 aliyun 或 acs:开头,不能包含 http://或 https://。 | env |
Value | string | 否 | 标签值。最多支持 128 个字符,不能以 aliyun 或 acs:开头,不能包含 http://或 https://。 | product |
返回参数
示例
正常返回示例
JSON
格式
{
"HealthCheckTemplateId": "hct-pno8sisi******",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF34******"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | QuotaExceeded.HealthCheckTemplatesNum | The quota of %s is exceeded, usage %s/%s. | 配额%s已超额度限制,目前已使用%s,配额为%s。 |
403 | Forbidden.HealthCheckTemplate | Authentication has failed for HealthCheckTemplate. | 对HealthCheckTemplate鉴权失败 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-01-18 | OpenAPI 错误码发生变更 | 查看变更详情 |