Skip to content

Latest commit

 

History

History
212 lines (160 loc) · 8.47 KB

AlarmsApi.md

File metadata and controls

212 lines (160 loc) · 8.47 KB
Raw

greenlake_data_services.AlarmsApi

All URIs are relative to https://eu1.data.cloud.hpe.com

Method HTTP request Description
device_type2_get_alarms GET /api/v1/storage-systems/device-type2/{systemId}/alarms Get all alarms of Nimble / Alletra 6K
device_type2_get_alarms_using_alarm_id GET /api/v1/storage-systems/device-type2/{systemId}/alarms/{alarmId} Get all alarms of Nimble / Alletra 6K identified by {alarmId}

device_type2_get_alarms

NimbleAlarmsList device_type2_get_alarms(system_id)

Get all alarms of Nimble / Alletra 6K

Get all alarms of Nimble / Alletra 6K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import alarms_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_alarms_list import NimbleAlarmsList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "id eq 2a0df0fe6f7dc7bb16000000000000000000004817" # str | Lucene query to filter Alarms by Key. (optional)
    sort = "name desc" # str | Data query to sort Alarm resource by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all alarms of Nimble / Alletra 6K
        api_response = api_instance.device_type2_get_alarms(system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling AlarmsApi->device_type2_get_alarms: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all alarms of Nimble / Alletra 6K
        api_response = api_instance.device_type2_get_alarms(system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling AlarmsApi->device_type2_get_alarms: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str Lucene query to filter Alarms by Key. [optional]
sort str Data query to sort Alarm resource by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

NimbleAlarmsList

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_get_alarms_using_alarm_id

NimbleAlarmsWithRequestUri device_type2_get_alarms_using_alarm_id(system_id, alarm_id)

Get all alarms of Nimble / Alletra 6K identified by {alarmId}

Get all alarms of Nimble / Alletra 6K identified by {alarmId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import alarms_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_alarms_with_request_uri import NimbleAlarmsWithRequestUri
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    alarm_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the Alarm. A 42 digit hexadecimal number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all alarms of Nimble / Alletra 6K identified by {alarmId}
        api_response = api_instance.device_type2_get_alarms_using_alarm_id(system_id, alarm_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling AlarmsApi->device_type2_get_alarms_using_alarm_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all alarms of Nimble / Alletra 6K identified by {alarmId}
        api_response = api_instance.device_type2_get_alarms_using_alarm_id(system_id, alarm_id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling AlarmsApi->device_type2_get_alarms_using_alarm_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
alarm_id str ID of the Alarm. A 42 digit hexadecimal number.
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

NimbleAlarmsWithRequestUri

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]