acos-events message-id

Configure log message

message-id Specification

Parameter Value
Type Collection
Object Key(s) log-msg, message-id-scope-route
Collection Name message-id-list
Collection URI /axapi/v3/acos-events/message-id
Element Name message-id
Element URI /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}
Element Attributes message-id_attributes
Partition Visibility shared
Schema message-id schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/acos-events/message-id

message-id attributes

Create List

POST

/axapi/v3/acos-events/message-id

message-id attributes

Get Object

GET

/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}

message-id attributes

Get List

GET

/axapi/v3/acos-events/message-id

message-id-list

Modify Object

POST

/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}

message-id attributes

Replace Object

PUT

/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}

message-id attributes

Replace List

PUT

/axapi/v3/acos-events/message-id

message-id-list

Delete Object

DELETE

/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}

message-id attributes

message-id-list

message-id-list is JSON List of message-id attributes

message-id-list : [

message-id attributes

log-msg

Description Specify log message-id lineage

Type: string

Maximum Length: 512 characters

Maximum Length: 1 characters

message-id-scope-route

Description ‘all’: Log messages at this level and all sub-trees; ‘node-only’: Log messages at this node only; ‘children-only’: Log messages at all sub-trees only; ‘log-field-only’: This is a log-field (Default);

Type: string

Supported Values: all, node-only, children-only, log-field-only

Default: log-field-only

property

Description: property is a JSON Block. Please see below for property

Type: Object

Reference Object: /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

property

Specification Value
Type object

log-route

Description: log-route is a JSON Block. Please see below for property_log-route

Type: Object

Reference Object: /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/log-route

rate-limit

Description: rate-limit is a JSON Block. Please see below for property_rate-limit

Type: Object

Reference Object: /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/rate-limit

severity

Description: severity is a JSON Block. Please see below for property_severity

Type: Object

Reference Object: /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/severity

property_log-route

Specification Value
Type object

log-route-val

Description ‘local-only’: send logs to local-only; ‘remote-only’: send logs to remote-only; ‘local-and-remote’: send logs to both local and remote;

Type: string

Supported Values: local-only, remote-only, local-and-remote

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

property_severity

Specification Value
Type object

severity-val

Description ‘emergency’: System unusable log messages (Most Important); ‘alert’: Action must be taken immediately; ‘critical’: Critical conditions; ‘error’: Error conditions; ‘warning’: Warning conditions; ‘notification’: Normal but significant conditions; ‘information’: Informational messages; ‘debugging’: Debug level messages (Least Important);

Type: string

Supported Values: emergency, alert, critical, error, warning, notification, information, debugging

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

property_rate-limit

Specification Value
Type object

rate-limit-val

Description ‘enable’: enable rate-limiting of logs; ‘disable’: disable rate-limiting of logs;

Type: string

Supported Values: enable, disable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters