watcherclient.v1 包¶
子模块¶
- watcherclient.v1.action 模块
- watcherclient.v1.action_plan 模块
- watcherclient.v1.action_plan_shell 模块
- watcherclient.v1.action_shell 模块
- watcherclient.v1.audit 模块
- watcherclient.v1.audit_shell 模块
- watcherclient.v1.audit_template 模块
- watcherclient.v1.audit_template_shell 模块
- watcherclient.v1.client 模块
- watcherclient.v1.data_model 模块
- watcherclient.v1.data_model_shell 模块
- watcherclient.v1.goal 模块
- watcherclient.v1.goal_shell 模块
- watcherclient.v1.resource_fields 模块
- watcherclient.v1.scoring_engine 模块
- watcherclient.v1.scoring_engine_shell 模块
- watcherclient.v1.service 模块
- watcherclient.v1.service_shell 模块
- watcherclient.v1.strategy 模块
- watcherclient.v1.strategy_shell 模块
模块内容¶
- 类watcherclient.v1.ActionManager(api)[源代码]¶
基类:
Manager- list(action_plan=None, audit=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)[源代码]¶
检索操作列表。
- 参数:
action_plan – 操作计划的 UUID
audit – 审计的 UUID
limit –
- 每次请求返回的最大结果数,如果
limit > 0,返回操作的最大数量。
limit == 0,返回所有操作的列表。
limit 参数未指定 (None),返回的项目数量受 Watcher API 施加的最大限制 (请参阅 Watcher 的 api.max_limit 选项) 的影响。
sort_key – 可选,用于排序的字段。
sort_dir – 可选,排序方向,可以是 ‘asc’ (默认) 或 ‘desc’。
detail – 可选,布尔值,表示是否返回操作的详细信息。
marker – 可选,前一页中最后一个操作的 UUID。
resource_class¶
- 返回值:
操作列表。
- cancel(action_plan_id)[源代码]¶
基类:
Manager- 检索操作计划列表。
audit – 审计名称
- 参数:
limit > 0,返回操作计划的最大数量。
limit –
- 每次请求返回的最大结果数,如果
limit > 0,返回操作的最大数量。
limit == 0,返回所有操作计划的列表。
detail – 可选,布尔值,表示是否返回操作计划的详细信息。
sort_key – 可选,用于排序的字段。
sort_dir – 可选,排序方向,可以是 ‘asc’ (默认) 或 ‘desc’。
detail – 可选,布尔值,表示是否返回操作的详细信息。
marker – 前一页中最后一个 actionplan UUID;显示 “marker” 之后的操作计划列表。
操作计划列表。
- 返回值:
resource_class¶
-
别名
ActionPlan
- create(**kwargs)[源代码]¶
基类:
Manager- list(audit_template=None, limit=None, sort_key=None, sort_dir=None, detail=False, goal=None, strategy=None, marker=None)[源代码]¶
- 检索审计列表。
audit_template – 审计模板名称
- 参数:
limit > 0,返回审计的最大数量。
limit –
- 每次请求返回的最大结果数,如果
limit > 0,返回操作的最大数量。
limit == 0,返回所有审计的列表。
detail – 可选,布尔值,表示是否返回审计的详细信息。
sort_key – 可选,用于排序的字段。
sort_dir – 可选,排序方向,可以是 ‘asc’ (默认) 或 ‘desc’。
detail – 可选,布尔值,表示是否返回操作的详细信息。
marker – 前一页中最后一个审计 UUID;显示 “marker” 之后的审计列表。
marker – 可选,前一页审计的 UUID。
- 返回值:
审计列表。
- class watcherclient.v1.AuditTemplateManager(api)[source]¶
基类:
Manager- list(name=None, goal=None, strategy=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)[source]¶
检索审计模板列表。
- 参数:
name – 审计模板的名称
limit –
- 每次请求返回的最大结果数,如果
limit > 0,返回操作的最大数量。
limit > 0,返回的最大审计模板数量。
limit == 0,返回所有审计模板的列表。
sort_key – 可选,用于排序的字段。
sort_dir – 可选,排序方向,可以是 ‘asc’ (默认) 或 ‘desc’。
detail – 可选,布尔值,表示是否返回操作的详细信息。
detail – 可选,布尔值,表示是否返回审计模板的详细信息。
marker – 可选,前一页的最后一个审计模板的 UUID。
- 返回值:
审计模板列表。
- resource_class¶
AuditTemplate的别名
- class watcherclient.v1.DataModelManager(api)[source]¶
基类:
Manager
- class watcherclient.v1.GoalManager(api)[source]¶
基类:
Manager- list(limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)[source]¶
检索目标列表。
- 参数:
limit –
- 每次请求返回的最大结果数,如果
limit > 0,返回操作的最大数量。
limit == 0,返回所有审计的列表。
detail – 可选,布尔值,表示是否返回审计的详细信息。
sort_key – 可选,用于排序的字段。
sort_dir – 可选,排序方向,可以是 ‘asc’ (默认) 或 ‘desc’。
detail – 可选,布尔值,表示是否返回操作的详细信息。
marker – 前一页中最后一个审计 UUID;显示 “marker” 之后的审计列表。
marker – 可选,前一页的最后一个目标的 UUID。
- 返回值:
目标列表。
- class watcherclient.v1.ScoringEngineManager(api)[source]¶
基类:
Manager- list(limit=None, sort_key=None, sort_dir=None, detail=False)[source]¶
检索评分引擎列表。
- 参数:
limit –
- 每次请求返回的最大结果数,如果
limit > 0,返回操作的最大数量。
limit > 0,返回的最大评分引擎数量。
limit == 0,返回所有评分引擎的列表。
sort_key – 可选,用于排序的字段。
sort_dir – 可选,排序方向,可以是 ‘asc’ (默认) 或 ‘desc’。
detail – 可选,布尔值,表示是否返回操作的详细信息。
detail – 可选,布尔值,表示是否返回评分引擎的详细信息。
- 返回值:
评分引擎列表。
- resource_class¶
ScoringEngine的别名
- class watcherclient.v1.ServiceManager(api)[source]¶
基类:
Manager- list(limit=None, sort_key=None, sort_dir=None, detail=False)[source]¶
检索服务列表。
- 参数:
limit –
- 每次请求返回的最大结果数,如果
limit > 0,返回操作的最大数量。
limit > 0,返回的最大服务数量。
limit == 0,返回所有服务的列表。
sort_key – 可选,用于排序的字段。
sort_dir – 可选,排序方向,可以是 ‘asc’ (默认) 或 ‘desc’。
detail – 可选,布尔值,表示是否返回操作的详细信息。
detail – 可选,布尔值,表示是否返回服务的详细信息。
- 返回值:
服务列表。
- class watcherclient.v1.StrategyManager(api)[source]¶
基类:
Manager- list(goal=None, limit=None, sort_key=None, sort_dir=None, detail=False, marker=None)[source]¶
检索策略列表。
- 参数:
goal – 用于过滤的目标的 UUID
limit –
- 每次请求返回的最大结果数,如果
limit > 0,返回操作的最大数量。
limit == 0,返回所有审计的列表。
detail – 可选,布尔值,表示是否返回审计的详细信息。
sort_key – 可选,用于排序的字段。
sort_dir – 可选,排序方向,可以是 ‘asc’ (默认) 或 ‘desc’。
detail – 可选,布尔值,表示是否返回操作的详细信息。
marker – 前一页中最后一个审计 UUID;显示 “marker” 之后的审计列表。
marker – 可选,前一页中最后一个策略的 UUID。
- 返回值:
审计列表。