GET

Obtaining list of vip request

Obtaining list of vip request with some more details through id’s

URL:

/api/v3/vip-request/details/[vip_request_ids]/

where vip_request_ids are the identifiers of vip requests desired to be retrieved with details. It can use multiple ids separated by semicolons.

Example with Parameter IDs:

One ID:

/api/v3/vip-request/details/1/

Many IDs:

/api/v3/vip-request/details/1;3;8/

Response body:

{
    "vips": [{
        "id": (vip_id),
        "name": (string),
        "service": (string),
        "business": (string),
        "environmentvip": {
            "id": (environmentvip_id),
            "finalidade_txt": (string),
            "cliente_txt": (string),
            "ambiente_p44_txt": (string),
            "description": (string)
        },
        "ipv4": {
            "id": (ipv4_id)
            "ip_formated": (ipv4_formated),
            "description": (string)
        },
        "ipv6": null,
        "equipments": [{
            "id": (equipment_id),
            "name": (string),
            "equipment_type": (equipment_type_id),
            "model": (model_id),
            "groups": [(group_id),..]
        }],
        "default_names": [(string),..],
        "dscp": (vip_dscp_id),
        "ports": [{
            "id": (vip_port_id),
            "port": (integer),
            "options": {
                "l4_protocol": {
                    "id": (optionvip_id),
                    "tipo_opcao": (string),
                    "nome_opcao_txt": (string)
                },
                "l7_protocol": {
                    "id": (optionvip_id),
                    "tipo_opcao": (string),
                    "nome_opcao_txt": (string)
                }
            },
            "pools": [{
                "id": (vip_port_pool_id),
                "server_pool": {
                    'id': (server_pool_id),
                    ...information from the pool, same as GET Pool*
                },
                "l7_rule": {
                    "id": (optionvip_id),
                    "tipo_opcao": (string),
                    "nome_opcao_txt": (string)
                },
                "order": (integer|null),
                "l7_value": (string)
            },...]
        },...],
        "options": {
            "cache_group": {
                "id": (optionvip_id),
                "tipo_opcao": (string),
                "nome_opcao_txt": (string)
            },
            "traffic_return": {
                "id": (optionvip_id),
                "tipo_opcao": (string),
                "nome_opcao_txt": (string)
            },
            "timeout": {
                "id": (optionvip_id),
                "tipo_opcao": (string),
                "nome_opcao_txt": (string)
            },
            "persistence": {
                "id": (optionvip_id),
                "tipo_opcao": (string),
                "nome_opcao_txt": (string)
            }
        },
        "created": (boolean)
    },...]
}

  • “environmentvip” attribute receives a dict with some information about the environment vip associated with the retrieved vip request.

  • “options” are the configured options vip associated to the retrieved vip request.
    • cache-group, persistence, timeout and traffic_return are some values present in the database. These values are configured to a set of restricted values.
  • “ports” are the configured ports associated to the retrieved vip request.
    • l4_protocol and l7_protocol in options and l7_rule in pools work as well as the values present in “options” discussed above.
    • “server_pool” attribute receives a dict with some information about the server pool associated to the retrieved vip request.