• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Neutron
  5. LBaas
  6. List health monitors

List health monitors

Function Description

This interface is used to query a health check.

Interface Format

Method

URI

Description

GET

/v2.0/lbaas/healthmonitors

Queries all health checks on which the tenants sending requests to the system have permissions to perform operations.

Restrictions

N/A

Request Parameter

None

Response Parameter

Parameter

Type

Mandatory

Description

healthmonitors

List(healthmonitor)

Yes

Specifies the list of health checks. For details, see Table 6.

Request Example

GET /v2.0/lbaas/healthmonitors

Response Example

{
    "healthmonitors": [
        {
            "name": "",
            "admin_state_up": true,
            "tenant_id": "145483a5107745e9b3d80f956713e6a3",
            "delay": 5,
            "max_retries": 4,
            "timeout": 1,
            "pools": [
                {
                    "id": "163038be-d361-42f7-a872-668e4afc81fa"
                }
            ],
            "type": "TCP",
            "id": "10a9b3cf-d1a5-4429-879f-11f3b2d3747b"
        },
        {
            "name": "",
            "admin_state_up": true,
            "tenant_id": "145483a5107745e9b3d80f956713e6a3",
            "delay": 1,
            "max_retries": 3,
            "timeout": 1,
            "pools": [
                {
                    "id": "3fd243e9-864e-4bfd-88fa-c89c58bd1d4b"
                }
            ],
            "type": "TCP",
            "id": "005b7709-ccf8-4ca4-abe3-4775679d89a2"
        },
        {
            "name": "",
            "admin_state_up": true,
            "tenant_id": "145483a5107745e9b3d80f956713e6a3",
            "delay": 5,
            "max_retries": 4,
            "timeout": 1,
            "pools": [
                {
                    "id": "2a6283c5-d11d-460f-be8e-1798549be9a4"
                }
            ],
            "type": "TCP",
            "id": "5de30c09-0ab8-4558-938f-e75f99290dcf"
        },
        {
            "name": "",
            "admin_state_up": true,
            "tenant_id": "145483a5107745e9b3d80f956713e6a3",
            "delay": 7,
            "max_retries": 7,
            "timeout": 1,
            "pools": [
                {
                    "id": "64b2a278-3c1f-42f7-9132-e2442dae6ad1"
                }
            ],
            "type": "TCP",
            "id": "56def548-54f6-4933-a7c5-e5a131612f0b"
        },
        {
            "name": "",
            "admin_state_up": true,
            "tenant_id": "145483a5107745e9b3d80f956713e6a3",
            "delay": 3,
            "max_retries": 3,
            "timeout": 1,
            "pools": [
                {
                    "id": "188d203b-6cf9-40f5-ac13-17906a8d36f2"
                }
            ],
            "type": "TCP",
            "id": "c715e670-5569-4034-b590-c9121be1e19e"
        }
    ]
}

Error Code

See section Return Code Processing.