第19章 TDBaaS (Time Series Database as a Service)コマンドラインクライアント

--version

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

-v、--verbose

出力の詳細レベルが上がります。繰り返すことができます。

--log-file LOG_FILE

出力をログに記録するファイルを指定します。デフォルトでは無効になっています。

-q、--quiet

警告およびエラー以外の出力を減らします。

-h、--help

ヘルプメッセージを表示して終了します。

--debug

エラーのトレースバックを表示します。

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

認証リージョン名(Env: OS_REGION_NAME)

--os-interface <interface>

インターフェイスタイプを選択します。有効なインターフェイスタイプ：[admin、public、internal]。(env: OS_INTERFACE)

--gnocchi-api-version GNOCCHI_API_VERSION

デフォルトは env[GNOCCHI_API_VERSION] または 1 です。

--insecure

クライアントがセキュアでない TLS (https)要求を実行することを明示的に許可します。サーバーの証明書は認証局に対して検証されません。このオプションは注意して使用する必要があります。

--os-cacert <ca-certificate>

TLS (https)サーバー証明書の検証に使用する CA バンドルファイルを指定します。デフォルトは env[OS_CACERT] です。

--os-cert <certificate>

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

--os-key <key>

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

--timeout <seconds>

リクエストのタイムアウトを秒単位で設定します（秒単位）。

--os-auth-type <name>, --os-auth-plugin <name>

使用する認証タイプ

--gnocchi-endpoint <endpoint>

GNOCCHI_ENDPOINT エンドポイント(Env: GNOCCHI_ENDPOINT)

位置引数

name

アーカイブポリシーの名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

-b BACK_WINDOW, --back-window BACK_WINDOW

アーカイブポリシーのバックウィンドウ

-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS

アーカイブポリシーの集約方法

-d <DEFINITION>、--definition <DEFINITION>

名前と値が : で区切られたアーカイブポリシー定義の 2 つの属性(, で区切られます)

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

name

アーカイブポリシーの名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

CSV フォーマッター：

--quote {all,minimal,none,nonnumeric}

引用符を含める場合は、デフォルトで数字以外のものになります。

位置引数

name

ルール名

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME

アーカイブポリシー名

-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN

照合するメトリック名のワイルドカード

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

name

アーカイブポリシールールの名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

CSV フォーマッター：

--quote {all,minimal,none,nonnumeric}

引用符を含める場合は、デフォルトで数字以外のものになります。

位置引数

name

アーカイブポリシールールの名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

name

アーカイブポリシーの名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

metric

メトリクスの ID または名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

送信する合計計測値の数

--batch BATCH, -b BATCH

各バッチで送信する計測値の数

--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START

使用する最初のタイムスタンプ

--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END

使用する最終タイムスタンプ

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

metric

メトリクスの ID または名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--aggregation AGGREGATION

取得する集約

--start START

期間の開始

--stop STOP

期間の終わり

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

送信する合計計測値の数

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

作成するメトリックの数

--keep, -k

作成されたメトリックを保持します。

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

metric

メトリクスの ID または名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--workers WORKERS, -w WORKERS

使用するワーカー数

--count COUNT, -n COUNT

取得するメトリックの数

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

metric

メトリクスの ID または名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

-m MEASURE、--measure MEASURE

@ で区切られた計測のタイムスタンプおよび値

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

-M METRIC [METRIC ...], --metric METRIC [METRIC ...]

メトリクス ID またはメトリクス名

--aggregation AGGREGATION

取得する集約

--start START

期間の開始

--stop STOP

期間の終わり

--needed-overlap NEEDED_OVERLAP

各メトリックのデータポイントのパーセントが必要

--query QUERY

Query

出力フォーマッター

出力フォーマット設定オプション

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

CSV フォーマッター：

--quote {all,minimal,none,nonnumeric}

引用符を含める場合は、デフォルトで数字以外のものになります。

位置引数

metric

メトリクスの ID または名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--aggregation AGGREGATION

取得する集約

--start START

期間の開始

--stop STOP

期間の終わり

出力フォーマッター

出力フォーマット設定オプション

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

CSV フォーマッター：

--quote {all,minimal,none,nonnumeric}

引用符を含める場合は、デフォルトで数字以外のものになります。

位置引数

METRIC_NAME

メトリックの名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME

アーカイブポリシーの名前

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

metric

メトリクスの ID または名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

CSV フォーマッター：

--quote {all,minimal,none,nonnumeric}

引用符を含める場合は、デフォルトで数字以外のものになります。

位置引数

metric

メトリクスの ID または名前

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--resource-id RESOURCE_ID, -r RESOURCE_ID

リソースの ID

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

resource_id

リソースの ID

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

-a ATTRIBUTE、--attribute ATTRIBUTE

':' で区切られた属性の名前と値

-m ADD_METRIC, --add-metric ADD_METRIC

追加するメトリクスの名前：

-n CREATE_METRIC, --create-metric CREATE_METRIC

作成するメトリクスの name:archive_policy_name

-d DELETE_METRIC, --delete-metric DELETE_METRIC

削除するメトリックの名前

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

resource_id

リソースの ID

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

位置引数

resource_id

リソースの ID

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--details

汎用リソースの属性をすべて表示します。

--limit <LIMIT>

返すリソースの数（デフォルトはサーバーのデフォルト）。

--marker <MARKER>

前のリストの最後の項目です。この値の後に次の結果を返す

--sort <SORT>

リソース属性のソート (例:user_id:desc- nullslast)

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

出力フォーマッター

出力フォーマット設定オプション

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

CSV フォーマッター：

--quote {all,minimal,none,nonnumeric}

引用符を含める場合は、デフォルトで数字以外のものになります。

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--details

汎用リソースの属性をすべて表示します。

--history

リソースの履歴を表示します。

--limit <LIMIT>

返すリソースの数（デフォルトはサーバーのデフォルト）。

--marker <MARKER>

前のリストの最後の項目です。この値の後に次の結果を返す

--sort <SORT>

リソース属性のソート (例:user_id:desc- nullslast)

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

出力フォーマッター

出力フォーマット設定オプション

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

CSV フォーマッター：

--quote {all,minimal,none,nonnumeric}

引用符を含める場合は、デフォルトで数字以外のものになります。

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--details

汎用リソースの属性をすべて表示します。

--history

リソースの履歴を表示します。

--limit <LIMIT>

返すリソースの数（デフォルトはサーバーのデフォルト）。

--marker <MARKER>

前のリストの最後の項目です。この値の後に次の結果を返す

--sort <SORT>

リソース属性のソート (例:user_id:desc- nullslast)

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

--query QUERY

Query

出力フォーマッター

出力フォーマット設定オプション

-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

CSV フォーマッター：

--quote {all,minimal,none,nonnumeric}

引用符を含める場合は、デフォルトで数字以外のものになります。

位置引数

resource_id

リソースの ID

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

位置引数

resource_id

リソースの ID

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

--type RESOURCE_TYPE, -t RESOURCE_TYPE

リソースのタイプ

-a ATTRIBUTE、--attribute ATTRIBUTE

':' で区切られた属性の名前と値

-m ADD_METRIC, --add-metric ADD_METRIC

追加するメトリクスの名前：

-n CREATE_METRIC, --create-metric CREATE_METRIC

作成するメトリクスの name:archive_policy_name

-d DELETE_METRIC, --delete-metric DELETE_METRIC

削除するメトリックの名前

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。

オプションの引数

-h、--help

ヘルプメッセージを表示して終了します。

出力フォーマッター

出力フォーマット設定オプション

-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,table,value,yaml,yaml,yaml}

出力形式。デフォルトは table です。

-c COLUMN, --column COLUMN

追加する列を指定します。繰り返すことができます。

テーブルフォーマッター：

--max-width <integer>

最大表示幅。無効にする場合は 0

JSON フォーマッター：

--noindent

JSON のインデントを無効にするかどうか

シェルフォーマッター：

UNIX シェルが解析できる形式(variable="value")

--prefix PREFIX

すべての変数名に接頭辞を追加します。