文档首页/ 全球加速 GA/ API参考/ API/ 健康检查/ 查询健康检查列表
更新时间:2024-11-11 GMT+08:00
分享

查询健康检查列表

功能介绍

查询健康检查列表。

调用方法

请参见如何调用API

URI

GET /v1/health-checks

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

分页查询每页的资源个数。如果不设置,则默认为500。

marker

String

分页查询的起始的资源ID,表示上一页最后一条查询资源记录的ID。不指定时表示查询第一页。

必须与limit一起使用。

page_reverse

Boolean

分页的顺序,true表示从后往前分页,false表示从前往后分页,默认为false。

id

String

资源ID。

status

String

配置状态,可选范围:

  • ACTIVE:运行中

  • PENDING:待定

  • ERROR:错误

  • DELETING:正在删除

endpoint_group_id

String

终端节点组ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

health_checks

Array of HealthCheckDetail objects

健康检查列表。

page_info

PageInfo object

分页查询页的信息。

request_id

String

请求ID。

表4 HealthCheckDetail

参数

参数类型

描述

id

String

健康检查ID。

endpoint_group_id

String

终端节点组ID。

protocol

String

健康检查的协议。

status

String

配置状态,取值:

  • ACTIVE:运行中

  • PENDING:待定

  • ERROR:错误

  • DELETING:正在删除

port

Integer

健康检查的端口。

interval

Integer

健康检查的时间间隔,单位为秒。

timeout

Integer

健康检查的超时时间,单位为秒。建议该值小于interval的值。

max_retries

Integer

最大重试次数。将终端节点的状态从“健康”设置为“不健康”或从“不健康”设置为“健康”所需的连续健康检查次数。

created_at

String

创建时间。

updated_at

String

更新时间。

domain_id

String

租户ID。

enabled

Boolean

是否开启健康检查。

frozen_info

FrozenInfo object

云服务或资源实例冻结信息。

表5 FrozenInfo

参数

参数类型

描述

status

Integer

云服务或资源实例状态,取值:

  • 0:解冻/正常(云服务恢复正常)。

  • 1:冻结(资源和数据会保留,但租户无法再正常使用云服务)。

  • 2:删除/终止(资源和数据将清除)。

effect

Integer

在冻结/解冻操作下,取值:

  • 1(默认值):冻结可释放。

  • 2:冻结不可释放。

  • 3:冻结后不可续费。

scene

Array of strings

更新云服务状态的业务场景列表,取值:

  • ARREAR(默认值):欠费场景。为正常的运营业务场景,包括包周期资源到期、按需资源扣费失败。

  • POLICE:公安冻结场景。

  • ILLEGAL:违规冻结场景。

  • VERIFY:客户未实名认证冻结场景。

  • PARTNER:合作伙伴冻结(合作伙伴冻结子客户资源)。

表6 PageInfo

参数

参数类型

描述

next_marker

String

下一页的marker,为空时表示最后一页。

current_count

Integer

当前列表中资源数量。

请求示例

查询健康检查列表

GET https://{ga_endpoint}/v1/health-checks

响应示例

状态码: 200

操作成功

{
  "health_checks" : [ {
    "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7442",
    "endpoint_group_id" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
    "protocol" : "TCP",
    "status" : "ACTIVE",
    "port" : 3333,
    "interval" : 30,
    "timeout" : 30,
    "max_retries" : 1,
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "enabled" : true,
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    }
  } ],
  "page_info" : {
    "next_marker" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7442",
    "current_count" : 1
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

状态码

状态码

描述

200

操作成功

错误码

请参见错误码

相关文档