备案 控制台 登录 注册
文档中心 > DescribeHealthMonitor
DescribeHealthMonitor

最近更新时间：2022-06-28

请求方法：GET

接口描述：查询健康检查

请求参数

路径参数

参数名称

类型

是否必须

备注

Action

string

是

要执行的操作 DescribeHealthMonitor。

RegionId

string

是

节点Id。

Page

Integer

否

第几页。

Size

Integer

否

页大小。

Ids

string

否

健康检查ID。

LoadbalancerId

List<String>

否

SLB的ID。

ListenerIds

List<String>

否

监听器ID。

返回数据

参数名称

类型

备注

RequestId

string

请求ID。

Code

string

请求结果编码。

Msg

string

请求结果信息。

Res

object

请求结果数据。

Data

object

具体数据。

Page

integer

当前页。

Size

integer

每页数量。

Total

integer

一共有多少元素。

CheckInterval

integer

检查间隔，范围：1-60。

CheckType

string

类型PING、TCP、HTTP。

ExpectResponseCode

List<String>

正常状态码（http_2xx、http_3xx、http_4xx、http_5xx）。

HttpMethod

integer

HTTP方法（GET、POST）。

ListenerId

string

监听器ID。

LoadbalancerId

string

slb的ID。

MatchingUrl

string

检查路径。

MaxRetries

integer

最大重复次数，范围：1-10。

Name

string

名称。

Timeout

integer

超时时间，范围：1-60。

Open

boolean

是否开启。

Id

string

健康检查ID。

示例

请求示例

GET https://api.unicloud.com/networks/slb?Action=DescribeHealthMonitor&RegionId=HB1-BJMY

&Page=1

&Size=10

&公共请求参数

返回示例

   json

{

    "Code": "Network.Success",

    "Msg": "查询健康检查成功",

    "Res": {

        "Page": 1,

        "Data": [

            {

                "Name": "qwe",

                "CheckType": "HTTP",

                "HttpMethod": "GET",

                "MatchingUrl": "/qwe",

                "ExpectResponseCode": ["http_2xx", "http_3xx"],

                "CheckInterval": 5,

                "Timeout": 3,

                "MaxRetries": 3,

                "LoadbalancerId": "slb-ew051at6aetf",

                "Id": "wqejcopa-qwemdmq-qwempldas"

            }

        ],

        "Size": 1,

        "Total": 1

    },

    "RequestId": "789ee9c3-3255-4fac-9d4a-0036b014a695"

}