Files
tacker/api-ref/source/v2/parameters_prometheus_plugin.yaml
YiFeng c004eb25d9 Add docs for auto scale via PM Threshold API
This patch makes the following updates to the API and CLI docs.

* Add support CNF auto scale via PM Threshold interface

Implements: blueprint support-auto-lcm
Change-Id: Ic699dd973f5a9fc14196d5f0c80e9f6ab2a9ab88
2023-03-03 10:56:07 +09:00

175 lines
3.2 KiB
YAML

alerts:
description: alerts messages.
in: body
required: true
type: array
annotations:
description: |
dynamic properties.
in: body
required: true
type: object
aspect_id:
description: |
aspectId of the scaling target.
in: body
required: true
type: string
auto_scale_type:
description: |
'SCALE_OUT' for scaling out, 'SCALE_IN' for scaling in.
in: body
required: true
type: string
endsAt:
description: |
alert expiration time.
in: body
required: false
type: string
event_type:
description: |
eventType value defined in ETSI FM interface.
in: body
required: true
type: string
fault_details:
description: |
faultDetails defined in ETSI FM interface.
in: body
required: true
type: string
fault_type:
description: |
faultType defined in ETSI FM interface.
in: body
required: true
type: string
fingerprint:
description: |
id to identify alert.
in: body
required: true
type: string
function_type_auto_heal:
description: |
must be "auto_heal".
in: body
required: true
type: string
function_type_auto_scale:
description: |
must be "auto_scale".
in: body
required: true
type: string
function_type_fm:
description: |
must be "vnffm".
in: body
required: true
type: string
function_type_pm:
description: |
must be "vnfpm".
in: body
required: true
type: string
function_type_threshold:
description: |
must be "vnfpm_threshold".
in: body
required: true
type: string
job_id:
description: |
PM job id defined in ETSI PM interface.
in: body
required: true
type: string
labels:
description: |
static properties.
in: body
required: true
type: object
metric:
description: |
PerformanceMetric defined in ETSI PM interface.
in: body
required: true
type: string
object_instance_id:
description: |
objectInstanceId defined in ETSI PM interface.
in: body
required: true
type: string
perceived_severity:
description: |
perceivedSeverity value defined in ETSI FM interface.
in: body
required: true
type: string
pod:
description: |
Regex string that matches pods of Healing target.
For example, 'test\-test1\-[0-9a-f]{1,10}-[0-9a-z]{5}'
in: body
required: true
type: string
probable_cause:
description: |
probableCause defined in ETSI FM interface.
in: body
required: true
type: string
receiver_type:
description: |
must be "tacker".
in: body
required: true
type: string
startsAt:
description: |
alert firing time.
in: body
required: true
type: string
status:
description: |
'firing': alert is fired, 'resolved': alert is cleared.
in: body
required: true
type: String
sub_object_instance_id:
description: |
subObjectInstanceId defined in ETSI PM interface.
in: body
required: false
type: string
threshold_id:
description: |
PM Threshold id defined in ETSI PM interface.
in: body
required: true
type: string
value:
description: |
The result value returned by the PromQL statement.
in: body
required: false
type: number
vnf_instance_id:
description: |
Vnf Instance id.
in: body
required: true
type: string
vnfc_info_id:
description: |
Vnfc Info id.
in: body
required: true
type: string