GET
/v1/goal
¶Retrieve a list of goals.
Parameters: |
|
---|---|
Return type: |
GET
/v1/goal/
(goal)¶Retrieve information about the given goal.
Parameters: |
|
---|---|
Return type: |
GET
/v1/goal/detail
¶Retrieve a list of goals with detail.
Parameters: |
|
---|---|
Return type: |
GoalCollection
¶API representation of a collection of goals.
Data samples:
{
"goals": [
{
"display_name": "Dummy strategy",
"efficacy_specification": [
{
"description": "Dummy indicator",
"name": "dummy",
"schema": "Range(min=0, max=100, min_included=True, max_included=True, msg=None)",
"unit": "%"
}
],
"links": [
{
"href": "http://localhost:9322/v1/goals/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "self"
},
{
"href": "http://localhost:9322/goals/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "bookmark"
}
],
"name": "DUMMY",
"uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
]
}
goals
¶Type: | list(Goal) |
---|
A list containing goals objects
Goal
¶API representation of a goal.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a goal.
Data samples:
{
"display_name": "Dummy strategy",
"efficacy_specification": [
{
"description": "Dummy indicator",
"name": "dummy",
"schema": "Range(min=0, max=100, min_included=True, max_included=True, msg=None)",
"unit": "%"
}
],
"links": [
{
"href": "http://localhost:9322/v1/goals/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "self"
},
{
"href": "http://localhost:9322/goals/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "bookmark"
}
],
"name": "DUMMY",
"uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
display_name
¶Type: | unicode |
---|
Localized name of the goal
efficacy_specification
¶Type: | json |
---|
Efficacy specification for this goal
links
¶Type: | list(Link) |
---|
A list containing a self link and associated audit template links
name
¶Type: | unicode |
---|
Name of the goal
uuid
¶Type: | uuid |
---|
Unique UUID for this goal
GET
/v1/audit_templates
¶Retrieve a list of audit templates.
Parameters: |
|
---|---|
Return type: |
GET
/v1/audit_templates/
(audit_template)¶Retrieve information about the given audit template.
Parameters: |
|
---|---|
Return type: |
POST
/v1/audit_templates
¶Create a new audit template.
Parameters: |
|
---|---|
Return type: |
DELETE
/v1/audit_templates
¶Delete a audit template.
Parameters: |
|
---|
PATCH
/v1/audit_templates
¶Update an existing audit template.
Parameters: |
|
---|---|
Return type: |
GET
/v1/audit_templates/detail
¶Retrieve a list of audit templates with detail.
Parameters: |
|
---|---|
Return type: |
AuditTemplateCollection
¶API representation of a collection of audit templates.
Data samples:
{
"audit_templates": [
{
"goal_name": null,
"goal_uuid": null,
"links": [
{
"href": "http://localhost:9322/v1/audit_templates/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "self"
},
{
"href": "http://localhost:9322/audit_templates/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "bookmark"
}
],
"name": "My Audit Template",
"scope": [],
"strategy_name": null,
"strategy_uuid": null,
"uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
]
}
audit_templates
¶Type: | list(AuditTemplate) |
---|
A list containing audit templates objects
AuditTemplate
¶API representation of a audit template.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of an audit template.
Data samples:
{
"created_at": "2017-06-30T18:01:41.659344",
"deleted_at": null,
"description": "Description of my audit template",
"goal_name": null,
"goal_uuid": null,
"links": [
{
"href": "http://localhost:9322/v1/audit_templates/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "self"
},
{
"href": "http://localhost:9322/audit_templates/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "bookmark"
}
],
"name": "My Audit Template",
"scope": [],
"strategy_name": null,
"strategy_uuid": null,
"updated_at": "2017-06-30T18:01:41.659347",
"uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
audits
¶Type: | list(Link) |
---|
Links to the collection of audits contained in this audit template
description
¶Type: | unicode |
---|
Short description of this audit template
goal_name
¶Type: | unicode |
---|
The name of the goal this audit template refers to
goal_uuid
¶Type: | unicode |
---|
Goal UUID the audit template refers to
links
¶Type: | list(Link) |
---|
A list containing a self link and associated audit template links
name
¶Type: | unicode |
---|
Name of this audit template
scope
¶Type: | json |
---|
Audit Scope
strategy_name
¶Type: | unicode |
---|
The name of the strategy this audit template refers to
strategy_uuid
¶Type: | unicode |
---|
Strategy UUID the audit template refers to
uuid
¶Type: | uuid |
---|
Unique UUID for this audit template
GET
/v1/audits
¶Retrieve a list of audits.
Parameters: |
|
---|---|
Return type: |
GET
/v1/audits/
(audit_uuid)¶Retrieve information about the given audit.
Parameters: |
|
---|---|
Return type: |
POST
/v1/audits
¶Create a new audit.
Parameters: |
|
---|---|
Return type: |
DELETE
/v1/audits
¶Delete a audit.
Parameters: |
|
---|
PATCH
/v1/audits
¶Update an existing audit.
Parameters: |
|
---|---|
Return type: |
GET
/v1/audits/detail
¶Retrieve a list of audits with detail.
Parameters: |
|
---|---|
Return type: |
AuditCollection
¶API representation of a collection of audits.
Data samples:
{
"audits": [
{
"audit_type": "ONESHOT",
"auto_trigger": false,
"goal_name": null,
"goal_uuid": null,
"interval": 7200,
"links": [
{
"href": "http://localhost:9322/v1/audits/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "self"
},
{
"href": "http://localhost:9322/audits/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "bookmark"
}
],
"scope": [],
"state": "PENDING",
"strategy_name": null,
"strategy_uuid": null,
"uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
]
}
audits
¶Type: | list(Audit) |
---|
A list containing audits objects
Audit
¶API representation of a audit.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a audit.
Data samples:
{
"audit_type": "ONESHOT",
"auto_trigger": false,
"created_at": "2017-06-30T18:01:41.739867",
"deleted_at": null,
"goal_name": null,
"goal_uuid": null,
"interval": 7200,
"links": [
{
"href": "http://localhost:9322/v1/audits/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "self"
},
{
"href": "http://localhost:9322/audits/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "bookmark"
}
],
"scope": [],
"state": "PENDING",
"strategy_name": null,
"strategy_uuid": null,
"updated_at": "2017-06-30T18:01:41.739870",
"uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
audit_type
¶Type: | unicode |
---|
Type of this audit
auto_trigger
¶Type: | bool |
---|
Autoexecute action plan once audit is succeeded
goal_name
¶Type: | unicode |
---|
The name of the goal this audit template refers to
goal_uuid
¶Type: | unicode |
---|
Goal UUID the audit template refers to
interval
¶Type: | int |
---|
Launch audit periodically (in seconds)
links
¶Type: | list(Link) |
---|
A list containing a self link and associated audit links
parameters
¶Type: | dict(unicode: json) |
---|
The strategy parameters for this audit
scope
¶Type: | json |
---|
Audit Scope
state
¶Type: | unicode |
---|
This audit state
strategy_name
¶Type: | unicode |
---|
The name of the strategy this audit template refers to
strategy_uuid
¶Type: | unicode |
---|
Strategy UUID the audit template refers to
uuid
¶Type: | uuid |
---|
Unique UUID for this audit
GET
/v1/action_plans
¶Retrieve a list of action plans.
Parameters: |
|
---|---|
Return type: |
GET
/v1/action_plans/
(action_plan_uuid)¶Retrieve information about the given action plan.
Parameters: |
|
---|---|
Return type: |
DELETE
/v1/action_plans
¶Delete an action plan.
Parameters: |
|
---|
PATCH
/v1/action_plans
¶Update an existing action plan.
Parameters: |
|
---|---|
Return type: |
GET
/v1/action_plans/detail
¶Retrieve a list of action_plans with detail.
Parameters: |
|
---|---|
Return type: |
ActionPlanCollection
¶API representation of a collection of action_plans.
Data samples:
{
"action_plans": [
{
"audit_uuid": "abcee106-14d3-4515-b744-5a26885cf6f6",
"efficacy_indicators": [
{
"description": "Test indicator",
"name": "test_indicator",
"unit": "%"
}
],
"links": [
{
"href": "http://localhost:9322/v1/action_plans/9ef4d84c-41e8-4418-9220-ce55be0436af",
"rel": "self"
},
{
"href": "http://localhost:9322/action_plans/9ef4d84c-41e8-4418-9220-ce55be0436af",
"rel": "bookmark"
}
],
"state": "ONGOING",
"strategy_name": null,
"strategy_uuid": null,
"updated_at": "2017-06-30T18:01:41.827139",
"uuid": "9ef4d84c-41e8-4418-9220-ce55be0436af"
}
]
}
action_plans
¶Type: | list(ActionPlan) |
---|
A list containing action_plans objects
ActionPlan
¶API representation of a action plan.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of an action plan.
Data samples:
{
"audit_uuid": "abcee106-14d3-4515-b744-5a26885cf6f6",
"created_at": "2017-06-30T18:01:41.838009",
"deleted_at": null,
"efficacy_indicators": [
{
"description": "Test indicator",
"name": "test_indicator",
"unit": "%"
}
],
"links": [
{
"href": "http://localhost:9322/v1/action_plans/9ef4d84c-41e8-4418-9220-ce55be0436af",
"rel": "self"
},
{
"href": "http://localhost:9322/action_plans/9ef4d84c-41e8-4418-9220-ce55be0436af",
"rel": "bookmark"
}
],
"state": "ONGOING",
"strategy_name": null,
"strategy_uuid": null,
"updated_at": "2017-06-30T18:01:41.838013",
"uuid": "9ef4d84c-41e8-4418-9220-ce55be0436af"
}
audit_uuid
¶Type: | uuid |
---|
The UUID of the audit this port belongs to
efficacy_indicators
¶Type: | json |
---|
The list of efficacy indicators associated to this action plan
global_efficacy
¶Type: | json |
---|
The global efficacy of this action plan
links
¶Type: | list(Link) |
---|
A list containing a self link and associated action links
state
¶Type: | unicode |
---|
This action plan state
strategy_name
¶Type: | unicode |
---|
The name of the strategy this action plan refers to
strategy_uuid
¶Type: | unicode |
---|
Strategy UUID the action plan refers to
uuid
¶Type: | uuid |
---|
Unique UUID for this action plan
GET
/v1/actions
¶Retrieve a list of actions.
Parameters: |
|
---|---|
Return type: |
GET
/v1/actions/
(action_uuid)¶Retrieve information about the given action.
Parameters: |
|
---|---|
Return type: |
POST
/v1/actions
¶Create a new action.
Parameters: |
|
---|---|
Return type: |
DELETE
/v1/actions
¶Delete a action.
Parameters: |
|
---|
PATCH
/v1/actions
¶Update an existing action.
Parameters: |
|
---|---|
Return type: |
GET
/v1/actions/detail
¶Retrieve a list of actions with detail.
Parameters: |
|
---|---|
Return type: |
ActionCollection
¶API representation of a collection of actions.
Data samples:
{
"actions": [
{
"action_plan_uuid": "7ae81bb3-dec3-4289-8d6c-da80bd8001ae",
"links": [
{
"href": "http://localhost:9322/v1/actions/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "self"
},
{
"href": "http://localhost:9322/actions/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "bookmark"
}
],
"parents": [],
"state": "PENDING",
"uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
]
}
actions
¶Type: | list(Action) |
---|
A list containing actions objects
Action
¶API representation of a action.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a action.
Data samples:
{
"action_plan_uuid": "7ae81bb3-dec3-4289-8d6c-da80bd8001ae",
"created_at": "2017-06-30T18:01:41.913776",
"deleted_at": null,
"links": [
{
"href": "http://localhost:9322/v1/actions/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "self"
},
{
"href": "http://localhost:9322/actions/27e3153e-d5bf-4b7e-b517-fb518e17f34c",
"rel": "bookmark"
}
],
"parents": [],
"state": "PENDING",
"updated_at": "2017-06-30T18:01:41.913779",
"uuid": "27e3153e-d5bf-4b7e-b517-fb518e17f34c"
}
action_plan_uuid
¶Type: | uuid |
---|
The action plan this action belongs to
action_type
¶Type: | unicode |
---|
Action type
input_parameters
¶Type: | json |
---|
One or more key/value pairs
links
¶Type: | list(Link) |
---|
A list containing a self link and associated action links
parents
¶Type: | json |
---|
UUIDs of parent actions
state
¶Type: | unicode |
---|
This audit state
uuid
¶Type: | uuid |
---|
Unique UUID for this action
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.