查询指定地域的健康检查模板。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alb:ListHealthCheckTemplates | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
MaxResults | integer | 否 | 分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20。 | 50 |
HealthCheckTemplateIds | array | 否 | 健康检查模版 ID 列表。 | |
string | 否 | 健康检查模版 ID。最多支持 20 个健康检查模板 ID。如果传入则根据模板 ID 过滤。 | hct-bp1qjwo61pqz3ahltv**** | |
HealthCheckTemplateNames | array | 否 | 健康检查模板名称列表。 | |
string | 否 | 健康检查模版名称。最多支持 10 个健康检查模板名称。如果传入则根据模板名称过滤。 | test | |
Tag | array<object> | 否 | 标签。 | |
object | 否 | 标签结构。 | ||
Key | string | 否 | 标签键。最多支持 128 个字符,不能以 | env |
Value | string | 否 | 标签值。最多支持 128 个字符,不能以 | product |
返回参数
示例
正常返回示例
JSON
格式
{
"HealthCheckTemplates": [
{
"HealthCheckConnectPort": 80,
"HealthCheckHost": "$SERVER_IP",
"HealthCheckCodes": [
"http_2xx"
],
"HealthCheckHttpVersion": "HTTP 1.0",
"HealthCheckInterval": 5,
"HealthCheckMethod": "HEAD",
"HealthCheckPath": "/test/index.html",
"HealthCheckProtocol": "HTTP",
"HealthCheckTemplateId": "hct-bp1qjwo61pqz3ahltv****",
"HealthCheckTemplateName": "HealthCheckTemplate1",
"HealthCheckTimeout": 3,
"HealthyThreshold": 4,
"UnhealthyThreshold": 4,
"Tags": [
{
"Key": "env",
"Value": "product"
}
]
}
],
"MaxResults": 50,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF3******",
"TotalCount": 1000
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbidden.HealthCheckTemplate | Authentication has failed for HealthCheckTemplate. | 对HealthCheckTemplate鉴权失败 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-01-17 | OpenAPI 错误码发生变更 | 查看变更详情 |