CES API¶
The Cloud Eye Service Class¶
The CES high-level interface is available through the ces
member of a Connection
object. The
ces
member will only be added if the
otcextensions.sdk.register_otc_extensions(conn)
method is called.
Alarm Rule Operations¶
- class otcextensions.sdk.ces.v1._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
- alarms(**query)
Return a generator of alarms
- Parameters:
query (dict) – Optional query parameters to be sent to limit the resources being returned.
- Returns:
A generator of alarm objects
- Return type:
- get_alarm(alarm)
Return a single alarm
- create_alarm(**attrs)
Create a new Alarm from attributes
- Parameters:
attrs (dict) – Keyword arguments which will be used to create a
otcextensions.sdk.ces.v1.alarm.Alarm
- delete_alarm(alarm, ignore_missing=True)
Delete a Alarm
- Parameters:
alarm – key id or an instance of
otcextensions.sdk.ces.v1.alarm.Alarm
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the alarm does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent alarm.
- Returns:
Alarm been deleted
- Return type:
- find_alarm(name_or_id, ignore_missing=True)
Find a single alarm
- Parameters:
name_or_id – The name or ID of a alarm
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the alarm does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent alarm.
- Returns:
None
- switch_alarm_state(alarm)
Enables or disables Alarm
- Parameters:
alarm – The value can be the ID of an alarm or a
Alarm
instance.- Returns:
None
Monitoring Data Operations¶
- class otcextensions.sdk.ces.v1._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
- metric_data(**query)
Return a generator of Metric Data
- Parameters:
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
- Returns:
A generator of metric data objects
- Return type:
Miscellaneous Operations¶
- class otcextensions.sdk.ces.v1._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
- event_data(**query)
- Return a generator of host configurations for a specified
event type in a specified period of time.
- Parameters:
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
- Returns:
A generator of event data objects
- Return type:
- metrics(**query)
Return a generator of metrics
- Parameters:
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
- Returns:
A generator of metric objects
- Return type:
- quotas()
Return a generator of quotas
- Returns:
A generator of quota objects
- Return type: