info.py 1.29 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
# Copyright (c) 2016, Daniele Venzano
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
This module contains the Zoe Info API.
"""

import logging

22
from zoe_lib.api_base import ZoeAPIBase
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
from zoe_lib.exceptions import ZoeAPIException

log = logging.getLogger(__name__)


class ZoeInfoAPI(ZoeAPIBase):
    """
    The Info API class. This API exports static information about Zoe, versions and configuration.
    """
    def info(self):
        """
        Queries Zoe for versions and local configuration parameters.

        :return:
        """
        data, status_code = self._rest_get('/info')
        if status_code != 200:
40 41
            if status_code == 404:
                raise ZoeAPIException('API endpoint not found')
42 43 44
            raise ZoeAPIException(data['message'])
        else:
            return data