genvid.toolbox.LogsAPI¶
-
class
genvid.toolbox.
LogsAPI
(parent_api: genvid.toolbox.httpapi.BaseHttpApiTool, **kwargs)¶ ベースクラス:
genvid.toolbox.httpapi.BaseHttpApiTool
ログ API。 Bastion API および Cluster API を参照してください
バージョン 1.12.0 で追加.
-
NAME
= 'logs-api'¶
-
get_base_url
(timeout=0.0) → str¶ ベース URL を取得する。
-
get_logs
(timeout=0.0) → typing.List[dict]¶ ログのリストを取得する。
戻り値: ログのリスト。
-
set_logs
(logs: list, timeout=0.0)¶ ログのリストを返す。
パラメータ: - logs – ログのリストを設定する。
- timeout – タイムアウト (秒)。
-
create_log
(log_id: str, log: dict, timeout=0.0)¶ ログを作成する。
パラメータ: - log_id – ログ ID。
- log – ログ。
- timeout – タイムアウト (秒)。
-
update_log
(log_id: str, log: dict, timeout=0.0)¶ ログを更新する
パラメータ: - log_id – ログ ID。
- log – ログ。
- timeout – タイムアウト (秒)。
-
delete_logs
(timeout=0.0)¶ クラスタのリストを削除する。
パラメータ: timeout – タイムアウト (秒)。
-
delete_log
(log_id: str, timeout=0.0)¶ 指定したログを削除する。
パラメータ: - log_id – ログ ID。
- timeout – タイムアウト (秒)。
-
get_log_meta
(name: str, timeout=0.0) → dict¶ プロジェクトのログに関連付けられたメタデータを返す。
パラメータ: - name – ログ名。
- timeout – タイムアウト (秒)。
-
get_log_stream
(meta: dict, origin: str, offset: int, timeout=0.0)¶ メタで指定されたログのログストリームを返す。
パラメータ: - meta – ログのメタ情報。
- origin – ログの起点。start または end。
- offset – 原点へのオフセット。
- timeout – タイムアウト (秒)。
-
print_log
(name, output=None, tail=False, follow=False, lines=10, timeout=0.0)¶ 出力時にプロジェクトログを出力する。
パラメータ: - name – ログ名。
- output – None の場合、デフォルトは stdout。
- tail – True の場合、ログの最後を出力する。
- follow – True の場合、実行中ログ表示を継続する。
- lines – 表示するラインの概数。
- timeout – タイムアウト (秒)。
-
-
class
api_logs.
LogsAPI
¶