第13章 Telemetry サービスコマンドラインクライアント

サブコマンド

alarm-combination-create

他のアラームの状態に基づいて、新しいアラームを作成します。

alarm-combination-update

他のアラームの状態に基づいて、既存のアラームを更新します。

alarm-create

新しいアラームを作成します（非推奨）。代わりに alarm- threshold-create を使用してください。

alarm-delete

アラームを削除します。

alarm-event-create

イベントに基づいて新しいアラームを作成します。

alarm-event-update

イベントに基づいて既存のアラームを更新します。

alarm-gnocchi-aggregation-by-metrics-threshold-create

計算された統計に基づいて新しいアラームを作成します。

alarm-gnocchi-aggregation-by-metrics-threshold-update

計算された統計に基づいて既存のアラームを更新します。

alarm-gnocchi-aggregation-by-resources-threshold-create

計算された統計に基づいて新しいアラームを作成します。

alarm-gnocchi-aggregation-by-resources-threshold-update

計算された統計に基づいて既存のアラームを更新します。

alarm-gnocchi-resources-threshold-create

計算された統計に基づいて新しいアラームを作成します。

alarm-gnocchi-resources-threshold-update

計算された統計に基づいて既存のアラームを更新します。

alarm-history

アラームの変更履歴を表示します。

alarm-list

ユーザーのアラームを一覧表示します。

alarm-show

アラームを表示します。

alarm-state-get

アラームの状態を取得します。

alarm-state-set

アラームの状態を設定します。

alarm-threshold-create

計算された統計に基づいて新しいアラームを作成します。

alarm-threshold-update

計算された統計に基づいて既存のアラームを更新します。

alarm-update

既存のアラームを更新します（非推奨）。

capabilities

Ceilometer 機能を出力します。

event-list

イベントをリスト表示します。

event-show

特定のイベントを表示します。

event-type-list

イベントタイプを一覧表示します。

meter-list

ユーザーのメーターを一覧表示します。

query-alarm-history

Alarm History にクエリーを実行します。

query-alarms

Alarms にクエリーします。

query-samples

クエリーの例。

resource-list

リソースを一覧表示します。

resource-show

リソースを表示します。

sample-create

サンプルを作成します。

sample-create-list

サンプルリストを作成します。

sample-list

サンプルを一覧表示します(-m/-meter が設定されている場合は OldSample オブジェクトを返します)。

sample-show

サンプルを表示します。

statistics

メーターの統計を一覧表示します。

trait-description-list

イベントタイプのトレイト情報を一覧表示します。

trait-list

イベントタイプ <event_type> の <trait_name> という名前のすべての特性を一覧表示します。

bash-completion

すべてのコマンドとオプションを stdout に出力します。

help

このプログラムまたはそのサブコマンドのヘルプを表示します。

--version

プログラムのバージョン番号を表示して終了します。

-d、--debug

デフォルトは env[CEILOMETERCLIENT_DEBUG] です。

-v、--verbose

より詳細な出力を出力します。

--timeout TIMEOUT

レスポンスを待つ秒数。

--ceilometer-url <CEILOMETER_URL>

非推奨。代わりに --os-endpoint を使用してください。デフォルトは env[CEILOMETER_URL] です。

--ceilometer-api-version CEILOMETER_API_VERSION

デフォルトは env[CEILOMETER_API_VERSION] または 2 です。

--os-tenant-id <tenant-id>

デフォルトは env[OS_TENANT_ID] です。

--os-region-name <region-name>

デフォルトは env[OS_REGION_NAME] です。

--os-auth-token <auth-token>

デフォルトは env[OS_AUTH_TOKEN] です。

--os-service-type <service-type>

デフォルトは env[OS_SERVICE_TYPE] です。

--os-endpoint-type <endpoint-type>

デフォルトは env[OS_ENDPOINT_TYPE] です。

--os-cacert <cacert>

デフォルトは env[OS_CACERT] です。

--os-insecure <insecure>

デフォルトは env[OS_INSECURE] です。

--os-cert-file <cert-file>

デフォルトは env[OS_CERT_FILE] です。

--os-key-file <key-file>

デフォルトは env[OS_KEY_FILE] です。

--os-cert <cert>

デフォルトは env[OS_CERT] です。

--os-key <key>

デフォルトは env[OS_KEY] です。

--os-project-name <project-name>

デフォルトは env[OS_PROJECT_NAME] です。

--os-project-id <project-id>

デフォルトは env[OS_PROJECT_ID] です。

--os-project-domain-id <project-domain-id>

デフォルトは env[OS_PROJECT_DOMAIN_ID] です。

--os-project-domain-name <project-domain-name>

デフォルトは env[OS_PROJECT_DOMAIN_NAME] です。

--os-user-id <user-id>

デフォルトは env[OS_USER_ID] です。

--os-user-domain-id <user-domain-id>

デフォルトは env[OS_USER_DOMAIN_ID] です。

--os-user-domain-name <user-domain-name>

デフォルトは env[OS_USER_DOMAIN_NAME] です。

--os-endpoint <endpoint>

デフォルトは env[OS_ENDPOINT] です。

--os-auth-system <auth-system>

デフォルトは env[OS_AUTH_SYSTEM] です。

--os-username <username>

デフォルトは env[OS_USERNAME] です。

--os-password <password>

デフォルトは env[OS_PASSWORD] です。

--os-tenant-name <tenant-name>

デフォルトは env[OS_TENANT_NAME] です。

--os-token <token>

デフォルトは env[OS_TOKEN] です。

--os-auth-url <auth-url>

デフォルトは env[OS_AUTH_URL] です。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。必須。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--alarm_ids <ALARM IDS>

アラーム ID のリスト。必須。

--operator <OPERATOR>

比較する演算子。['and', 'or'] のいずれかです。

位置引数

<ALARM_ID>

更新するアラームの ID。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--remove-time-constraint <Constraint names>

削除する時間制約の名前またはリスト。

--alarm_ids <ALARM IDS>

アラーム ID のリスト。

--operator <OPERATOR>

比較する演算子。['and', 'or'] のいずれかです。

位置引数

<ALARM_ID>

削除するアラームの ID。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。必須。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--event-type <EVENT_TYPE>

イベントアラームのイベントタイプ。

-q <QUERY>, --query <QUERY>

key[op]data_type::value; イベントをフィルタリングするためのリスト。data_type は任意ですが、指定する場合は string、integer、float、または datetime にする必要があります。

位置引数

<ALARM_ID>

更新するアラームの ID。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--event-type <EVENT_TYPE>

イベントアラームのイベントタイプ。

-q <QUERY>, --query <QUERY>

key[op]data_type::value; イベントをフィルタリングするためのリスト。data_type は任意ですが、指定する場合は string、integer、float、または datetime にする必要があります。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。必須。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--granularity <GRANULARITY>

評価する各期間の長さ (秒単位)。

--evaluation-periods <COUNT>

評価する期間数です。

--aggregation-method <AGGREATION>

使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。

--comparison-operator <OPERATOR>

比較する演算子：['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。

--threshold <THRESHOLD>

評価するしきい値。必須。

-m <METRICS>、--metrics <METRICS>

評価対象のメトリック。必須。

位置引数

<ALARM_ID>

更新するアラームの ID。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--granularity <GRANULARITY>

評価する各期間の長さ (秒単位)。

--evaluation-periods <COUNT>

評価する期間数です。

--aggregation-method <AGGREATION>

使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。

--comparison-operator <OPERATOR>

比較する演算子：['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。

--threshold <THRESHOLD>

評価するしきい値。

-m <METRICS>、--metrics <METRICS>

評価対象のメトリック。

--remove-time-constraint <Constraint names>

削除する時間制約の名前またはリスト。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。必須。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--granularity <GRANULARITY>

評価する各期間の長さ (秒単位)。

--evaluation-periods <COUNT>

評価する期間数です。

--aggregation-method <AGGREATION>

使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。

--comparison-operator <OPERATOR>

比較する演算子：['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。

--threshold <THRESHOLD>

評価するしきい値。必須。

-M <METRIC>、--metric <METRIC>

評価対象のメトリック。必須。

--resource-type <RESOURCE_TYPE>

評価する resource_type。必須。

--query <QUERY>

Gnocchi リソース検索クエリーフィルターが必要です。

位置引数

<ALARM_ID>

更新するアラームの ID。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--granularity <GRANULARITY>

評価する各期間の長さ (秒単位)。

--evaluation-periods <COUNT>

評価する期間数です。

--aggregation-method <AGGREATION>

使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。

--comparison-operator <OPERATOR>

比較する演算子：['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。

--threshold <THRESHOLD>

評価するしきい値。

-M <METRIC>、--metric <METRIC>

評価対象のメトリック。

--resource-type <RESOURCE_TYPE>

評価する resource_type。

--query <QUERY>

Gnocchi リソース検索クエリーフィルター

--remove-time-constraint <Constraint names>

削除する時間制約の名前またはリスト。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。必須。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--granularity <GRANULARITY>

評価する各期間の長さ (秒単位)。

--evaluation-periods <COUNT>

評価する期間数です。

--aggregation-method <AGGREATION>

使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。

--comparison-operator <OPERATOR>

比較する演算子：['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。

--threshold <THRESHOLD>

評価するしきい値。必須。

-M <METRIC>、--metric <METRIC>

評価対象のメトリック。必須。

--resource-type <RESOURCE_TYPE>

評価する resource_type。必須。

--resource-id <RESOURCE_ID>

必須に対して評価するリソース ID。

位置引数

<ALARM_ID>

更新するアラームの ID。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--granularity <GRANULARITY>

評価する各期間の長さ (秒単位)。

--evaluation-periods <COUNT>

評価する期間数です。

--aggregation-method <AGGREATION>

使用する集約メソッド。['max'、'min'、'avg'、'sum'、'count'] のいずれか。

--comparison-operator <OPERATOR>

比較する演算子：['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。

--threshold <THRESHOLD>

評価するしきい値。

-M <METRIC>、--metric <METRIC>

評価対象のメトリック。

--resource-type <RESOURCE_TYPE>

評価する resource_type。

--resource-id <RESOURCE_ID>

評価するリソース ID

--remove-time-constraint <Constraint names>

削除する時間制約の名前またはリスト。

位置引数

<ALARM_ID>

履歴が表示されるアラームの ID。

オプションの引数

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

オプションの引数

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

位置引数

<ALARM_ID>

表示するアラームの ID。

位置引数

<ALARM_ID>

表示するアラーム状態の ID。

位置引数

<ALARM_ID>

設定するアラーム状態の ID。

オプションの引数

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか。必須。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。必須。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

-M <METRIC>、--meter-name <METRIC>

評価対象のメトリック。必須。

--period <PERIOD>

評価する各期間の長さ (秒単位)。

--evaluation-periods <COUNT>

評価する期間数です。

--statistic <STATISTIC>

評価するための統計。['max'、'min'、'avg'、'sum'、'count'] のいずれか。

--comparison-operator <OPERATOR>

比較する演算子：['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。

--threshold <THRESHOLD>

評価するしきい値。必須。

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

位置引数

<ALARM_ID>

更新するアラームの ID。

オプションの引数

--name <NAME>

アラームの名前（テナントごとに一意である必要があります）。

--project-id <ALARM_PROJECT_ID>

アラームに関連付けるテナント（管理者ユーザーのみが設定可能）。

--user-id <ALARM_USER_ID>

アラームに関連付けるユーザー（管理者ユーザーのみが設定可能）。

--description <DESCRIPTION>

アラームのフリーテキストの説明。

--state <STATE>

アラームの状態。['ok'、'alarm'、'insufficient data'] のいずれか

--severity <SEVERITY>

アラームの重大度。['low'、'moderate'、'critical'] のいずれか

--enabled {True|False}

True を指定すると、アラームの評価/アクションが有効になります。

--alarm-action <Webhook URL>

アラームが遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--ok-action <Webhook URL>

状態が OK に遷移したときに呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--insufficient-data-action <Webhook URL>

状態が不十分なデータに移行する際に呼び出す URL。複数回の使用が可能です。デフォルトは None です。

--time-constraint <Time Constraint>

評価時間がこの時間制約内である場合にのみアラームを評価します。制約の開始点は cron 式で指定され、その期間は秒単位で指定されます。複数の時間制約に複数回指定できます。形式は、name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] のデフォルトです。

--repeat-actions {True|False}

True を指定すると、アラームがターゲット状態のままにアクションが繰り返し通知されます。デフォルトは False です。

--remove-time-constraint <Constraint names>

削除する時間制約の名前またはリスト。

-M <METRIC>、--meter-name <METRIC>

評価対象のメトリック。

--period <PERIOD>

評価する各期間の長さ (秒単位)。

--evaluation-periods <COUNT>

評価する期間数です。

--statistic <STATISTIC>

評価するための統計。['max'、'min'、'avg'、'sum'、'count'] のいずれか。

--comparison-operator <OPERATOR>

比較する演算子：['lt'、'le'、'eq'、'ne'、'ge'、'gt'] のいずれか。

--threshold <THRESHOLD>

評価するしきい値。

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

オプションの引数

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、floator datetime にする必要があります。

--no-traits

指定した場合、特性は出力されません。

-l <NUMBER>, --limit <NUMBER>

返すイベントの最大数。

位置引数

<MESSAGE_ID>

イベント ID。UUID である必要があります。

オプションの引数

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

-l <NUMBER>, --limit <NUMBER>

返すメーターの最大数。

オプションの引数

-f <FILTER>, --filter <FILTER>

{complex_op: [{simple_op: {field_name: value}}]} complex_op は ['and', 'or'], simple_op のいずれかになります：['=', '!=', '<', '<', '<=', '>', '>='] のいずれかです。

-o <ORDERBY>, --orderby <ORDERBY>

[{field_name: direction}, {field_name: direction}] 方向は ['asc', 'desc'] のいずれかになります。

-l <LIMIT>, --limit <LIMIT>

返すアラーム履歴項目の最大数。

オプションの引数

-f <FILTER>, --filter <FILTER>

{complex_op: [{simple_op: {field_name: value}}]} complex_op は ['and', 'or'], simple_op のいずれかになります：['=', '!=', '<', '<', '<=', '>', '>='] のいずれかです。

-o <ORDERBY>, --orderby <ORDERBY>

[{field_name: direction}, {field_name: direction}] 方向は ['asc', 'desc'] のいずれかになります。

-l <LIMIT>, --limit <LIMIT>

返すアラームの最大数。

オプションの引数

-f <FILTER>, --filter <FILTER>

{complex_op: [{simple_op: {field_name: value}}]} complex_op は ['and', 'or'], simple_op のいずれかになります：['=', '!=', '<', '<', '<=', '>', '>='] のいずれかです。

-o <ORDERBY>, --orderby <ORDERBY>

[{field_name: direction}, {field_name: direction}] 方向は ['asc', 'desc'] のいずれかになります。

-l <LIMIT>, --limit <LIMIT>

返すサンプルの最大数。

オプションの引数

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

-l <NUMBER>, --limit <NUMBER>

返すリソースの最大数。

位置引数

<RESOURCE_ID>

表示するリソースの ID。

オプションの引数

--project-id <SAMPLE_PROJECT_ID>

サンプルに関連付けるテナント（管理者ユーザーのみが設定できます）。

--user-id <SAMPLE_USER_ID>

サンプルに関連付ける user （管理者ユーザーのみが設定可能）。

-r <RESOURCE_ID>, --resource-id <RESOURCE_ID>

リソースの ID。必須。

-M <METER_NAME>、--meter-name <METER_NAME>

メーター名。必須。

--meter-type <METER_TYPE>

メーターのタイプ。必須。

--meter-unit <METER_UNIT>

メーターユニット。必須。

--sample-volume <SAMPLE_VOLUME>

サンプルボリューム。必須。

--resource-metadata <RESOURCE_METADATA>

リソースのメタデータ。指定された値はキーと値のペアのセットである必要があります（例：{"key":"value"}）。

--timestamp <TIMESTAMP>

サンプルのタイムスタンプ。

--direct <DIRECT>

ストレージに直接サンプルを投稿します。デフォルトは False です。

位置引数

<SAMPLES_LIST>

作成するサンプルを含む JSON 配列。

オプションの引数

--direct <DIRECT>

ストレージに直接サンプルを投稿します。デフォルトは False です。

オプションの引数

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

-m <NAME>、--meter <NAME>

サンプルを表示するメーターの名前。

-l <NUMBER>, --limit <NUMBER>

返すサンプルの最大数。

位置引数

<SAMPLE_ID>

表示するサンプルの ID （メッセージ ID）。

オプションの引数

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list. data_type は任意ですが、指定する場合は string、integer、float、または boolean にする必要があります。

-m <NAME>、--meter <NAME>

統計を一覧表示するメーターの名前。必須。

-p <PERIOD>、--period <PERIOD>

サンプルをグループ化する期間（秒単位）。

-g <FIELD>, --groupby <FIELD>

グループ別のフィールド。

-a <FUNC>[<-<PARAM>]、--aggregate <FUNC>[<-<PARAM>]

データ集約用の関数。利用可能な集約値は、count、cardinality、min、max、sum、stddev、avg です。デフォルトは [] です。

オプションの引数

-e <EVENT_TYPE>、--event_type <EVENT_TYPE>

特性が表示されるイベントのタイプ。必須。

オプションの引数

-e <EVENT_TYPE>、--event_type <EVENT_TYPE>

特性を一覧表示するイベントのタイプ。必須。

-t <TRAIT_NAME>, --trait_name <TRAIT_NAME>

一覧表示する特性の名前。必須。